From 044ac3799ddc4a441b82804ae810bab0690ae239 Mon Sep 17 00:00:00 2001 From: Mark Potse Date: Sat, 2 Mar 2024 12:49:45 +0100 Subject: [PATCH 01/11] warming-up: documentation fixes notably in src/mmg3d/libmmg3d.h --- CONTRIBUTING.md | 6 +- src/mmg3d/libmmg3d.h | 611 ++++++++++++++++++++++--------------------- 2 files changed, 324 insertions(+), 293 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9a93aafc1..822152b86 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,7 +5,8 @@ Our project use **Doxygen** to automatically generate the developer documentation. If you implement a new function in **Mmg**, please, comment it and give at least its interface description (function's arguments and return values). For example a minimal documentation for the function that save the mesh may be this one: -```c + +``` /** * \param mesh pointer toward the mesh structure. * \param filename pointer toward the name of file. @@ -26,7 +27,8 @@ You can refer to the [Doxygen documentation](http://www.stack.nl/~dimitri/doxyge Because the library header for Fortran users is automatically generated from the C header, you must add to your documentation the interface of the fortran function. Each line of this interface must begin with the `>` symbol and end with the `\n` one. For example, if the previous function is an API function, its documentation becames the following: -```c + +``` /** * \param mesh pointer toward the mesh structure. * \param filename pointer toward the name of file. diff --git a/src/mmg3d/libmmg3d.h b/src/mmg3d/libmmg3d.h index 1f3a072b9..3d3a85a37 100644 --- a/src/mmg3d/libmmg3d.h +++ b/src/mmg3d/libmmg3d.h @@ -30,15 +30,39 @@ * \copyright GNU Lesser General Public License. * \warning To keep the genheader working, don't break line between the enum * name and the opening brace (it creates errors under windows) - * \warning Use the MMG3D_ prefix: MMG5_ prefix will became obsolete... + * \warning Use the MMG3D_ prefix: the MMG5_ prefix will become obsolete. * + * \htmlonly + * + *

Examples

+ * \endhtmlonly + * + * A very simple example code for mesh adaptation with automatic parsing of .mesh files * \include libexamples/mmg3d/adaptation_example0/example0_a/main.c - * \include libexamples/mmg3d/example0/adaptation_example0_b/main.c + * + * Mesh adaptation example in which get/set functions are used to provide input to + * the library and to extract the output mesh. + * \include libexamples/mmg3d/adaptation_example0/example0_b/main.c + * + * Fortran example. * \include libexamples/mmg3d/adaptation_example0_fortran/example0_a/main.F90 + * + * Another Fortran example. * \include libexamples/mmg3d/adaptation_example0_fortran/example0_b/main.F90 + * + * Mesh adaptation example. * \include libexamples/mmg3d/adaptation_example1/main.c + * + * Mesh adaptation example. * \include libexamples/mmg3d/adaptation_example2/main.c - * \include libexamples/mmg3d/IsosurfDiscretization_example0/main.c + * + * Isosurface discretization example (with metric) + * \include libexamples/mmg3d/IsosurfDiscretization_lsAndMetric/main.c + * + * Lagrangian motion example. * \include libexamples/mmg3d/LagrangianMotion_example0/main.c */ @@ -145,8 +169,8 @@ enum MMG3D_Param { */ LIBMMG3D_EXPORT int MMG3D_Init_mesh(const int starter,...); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure. * * Initialize file names to their default values. * @@ -158,7 +182,7 @@ enum MMG3D_Param { */ LIBMMG3D_EXPORT void MMG3D_Init_fileNames(MMG5_pMesh mesh, MMG5_pSol sol); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * * Initialization of the input parameters (stored in the Info structure). * @@ -172,7 +196,7 @@ enum MMG3D_Param { /* init file names */ /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param meshin input mesh name. * \return 1. * @@ -189,7 +213,7 @@ enum MMG3D_Param { */ LIBMMG3D_EXPORT int MMG3D_Set_inputMeshName(MMG5_pMesh mesh,const char* meshin); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param meshout name of the output mesh file. * \return 1. * @@ -206,8 +230,8 @@ enum MMG3D_Param { */ LIBMMG3D_EXPORT int MMG3D_Set_outputMeshName(MMG5_pMesh mesh, const char* meshout); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure. * \param solin name of the input solution file. * \return 1. * @@ -225,8 +249,8 @@ enum MMG3D_Param { LIBMMG3D_EXPORT int MMG3D_Set_inputSolName(MMG5_pMesh mesh,MMG5_pSol sol, const char* solin); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure. * \param solout name of the output solution file. * \return 0 if failed, 1 otherwise. * @@ -244,7 +268,7 @@ enum MMG3D_Param { LIBMMG3D_EXPORT int MMG3D_Set_outputSolName(MMG5_pMesh mesh,MMG5_pSol sol, const char* solout); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param fparamin name of the input parameter file. * \return 1. * @@ -264,8 +288,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara /* init structure sizes */ /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure. * \param typEntity type of solutions entities (vertices, triangles...). * \param np number of solutions. * \param typSol type of solution (scalar, vectorial...). @@ -287,8 +311,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara MMG5_int np, int typSol); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward an allocatable sol structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to an allocatable sol structure. * \param nsols number of solutions per entity * \param nentities number of vertices * \param typSol Array of size nsols listing the type of the solutions @@ -313,7 +337,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara MMG5_int nentities, int *typSol); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param np number of vertices. * \param ne number of tetrahedra. * \param nprism number of prisms. @@ -339,7 +363,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara /* init structure datas */ /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param c0 coordinate of the point along the first dimension. * \param c1 coordinate of the point along the second dimension. * \param c2 coordinate of the point along the third dimension. @@ -362,15 +386,18 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Set_vertex(MMG5_pMesh mesh, double c0, double c1, double c2, MMG5_int ref,MMG5_int pos); /** - * \param mesh pointer toward the mesh structure. - * \param vertices table of the points coor. - * The coordinates of the \f$i^{th}\f$ point are stored in + * \brief Set vertex coordinates and references in a mesh structure + * + * \param mesh pointer to the mesh structure. * vertices[(i-1)*3]\@3. - * \param refs table of points references. - * The ref of the \f$i^th\f$ point is stored in refs[i-1]. + * \param vertices array of vertex coordinates in the order \f$[x_1, y_1, z_1, x_2, \ldots, z_N]\f$ + * where \f$N\f$ is the number of vertices in the mesh. + * \param refs array of point references. + * The reference of point \f$i\f$ is stored in refs[\f$i-1\f$]. * \return 1. * - * Set vertices coordinates and references in mesh structure + * This function sets the coordinates and references of all vertices in a mesh + * structure. The number of vertices in the mesh must have been set before. * * \remark Fortran interface: (commentated in order to allow to pass * \%val(0) instead of the refs array) @@ -384,8 +411,9 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara * */ LIBMMG3D_EXPORT int MMG3D_Set_vertices(MMG5_pMesh mesh, double *vertices,MMG5_int *refs); + /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param v0 first vertex of tetrahedron. * \param v1 second vertex of tetrahedron. * \param v2 third vertex of tetrahedron. @@ -408,8 +436,9 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara */ LIBMMG3D_EXPORT int MMG3D_Set_tetrahedron(MMG5_pMesh mesh, MMG5_int v0, MMG5_int v1, MMG5_int v2, MMG5_int v3, MMG5_int ref, MMG5_int pos); + /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param tetra vertices of the tetras of the mesh * Vertices of the \f$i^{th}\f$ tetra are stored in tetra[(i-1)*4]\@4. * \param refs table of the tetrahedra references. @@ -432,7 +461,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Set_tetrahedra(MMG5_pMesh mesh, MMG5_int *tetra, MMG5_int *refs); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param v0 first vertex of prism. * \param v1 second vertex of prism. * \param v2 third vertex of prism. @@ -457,7 +486,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Set_prism(MMG5_pMesh mesh, MMG5_int v0, MMG5_int v1, MMG5_int v2, MMG5_int v3, MMG5_int v4, MMG5_int v5, MMG5_int ref, MMG5_int pos); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param prisms vertices of the prisms of the mesh * Vertices of the \f$i^{th}\f$ prism are stored in prism[(i-1)*6]\@6. * \param refs table of the prisms references. @@ -481,7 +510,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara MMG5_int *refs); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param v0 first vertex of triangle. * \param v1 second vertex of triangle. * \param v2 third vertex of triangle. @@ -503,10 +532,10 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Set_triangle(MMG5_pMesh mesh, MMG5_int v0, MMG5_int v1, MMG5_int v2, MMG5_int ref,MMG5_int pos); /** - * \param mesh pointer toward the mesh structure. - * \param tria pointer toward the table of the tria vertices + * \param mesh pointer to the mesh structure. + * \param tria pointer to the table of the tria vertices * Vertices of the \f$i^{th}\f$ tria are stored in tria[(i-1)*3]\@3. - * \param refs pointer toward the table of the triangle references. + * \param refs pointer to the table of the triangle references. * refs[i-1] is the ref of the \f$i^{th}\f$ tria. * \return 0 if failed, 1 otherwise. * @@ -525,7 +554,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara */ LIBMMG3D_EXPORT int MMG3D_Set_triangles(MMG5_pMesh mesh, MMG5_int *tria, MMG5_int *refs); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param v0 first vertex of quadrilateral. * \param v1 second vertex of quadrilateral. * \param v2 third vertex of quadrilateral. @@ -548,10 +577,10 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Set_quadrilateral(MMG5_pMesh mesh, MMG5_int v0, MMG5_int v1, MMG5_int v2, MMG5_int v3, MMG5_int ref,MMG5_int pos); /** - * \param mesh pointer toward the mesh structure. - * \param quads pointer toward the table of the quads vertices + * \param mesh pointer to the mesh structure. + * \param quads pointer to the table of the quads vertices * Vertices of the \f$i^{th}\f$ quadra are stored in quads[(i-1)*3]\@3. - * \param refs pointer toward the table of the quadrilateral references. + * \param refs pointer to the table of the quadrilateral references. * refs[i-1] is the ref of the \f$i^{th}\f$ quadra. * \return 0 if failed, 1 otherwise. * @@ -570,7 +599,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara */ LIBMMG3D_EXPORT int MMG3D_Set_quadrilaterals(MMG5_pMesh mesh, MMG5_int *quads, MMG5_int *refs); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param v0 first extremity of the edge. * \param v1 second extremity of the edge. * \param ref edge reference. @@ -590,7 +619,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara */ LIBMMG3D_EXPORT int MMG3D_Set_edge(MMG5_pMesh mesh, MMG5_int v0, MMG5_int v1, MMG5_int ref,MMG5_int pos); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param k vertex index. * \return 1. * @@ -607,7 +636,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Set_corner(MMG5_pMesh mesh, MMG5_int k); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param k vertex index. * \return 1. * @@ -625,7 +654,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Unset_corner(MMG5_pMesh mesh, MMG5_int k); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param k vertex index. * \return 1. * @@ -642,7 +671,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Set_requiredVertex(MMG5_pMesh mesh, MMG5_int k); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param k vertex index. * \return 1. * @@ -659,7 +688,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Unset_requiredVertex(MMG5_pMesh mesh, MMG5_int k); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param k element index. * \return 1. * @@ -676,7 +705,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Set_requiredTetrahedron(MMG5_pMesh mesh, MMG5_int k); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param k element index. * \return 1. * @@ -694,7 +723,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Unset_requiredTetrahedron(MMG5_pMesh mesh, MMG5_int k); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param reqIdx table of the indices of the required elements. * \param nreq number of required elements * \return 1. @@ -713,7 +742,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Set_requiredTetrahedra(MMG5_pMesh mesh, MMG5_int *reqIdx, MMG5_int nreq); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param reqIdx table of the indices of the required elements. * \param nreq number of required elements * \return 1. @@ -733,7 +762,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Unset_requiredTetrahedra(MMG5_pMesh mesh, MMG5_int *reqIdx, MMG5_int nreq); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param k triangle index. * \return 1. * @@ -750,7 +779,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Set_requiredTriangle(MMG5_pMesh mesh, MMG5_int k); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param k triangle index. * \return 1. * @@ -767,7 +796,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Unset_requiredTriangle(MMG5_pMesh mesh, MMG5_int k); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param reqIdx table of the indices of the required trias. * \param nreq number of required trias * \return 1. @@ -786,7 +815,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Set_requiredTriangles(MMG5_pMesh mesh, MMG5_int *reqIdx, MMG5_int nreq); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param reqIdx table of the indices of the required trias. * \param nreq number of required trias * \return 1. @@ -805,7 +834,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Unset_requiredTriangles(MMG5_pMesh mesh, MMG5_int *reqIdx, MMG5_int nreq); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param k triangle index. * \return 1. * @@ -823,7 +852,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Set_parallelTriangle(MMG5_pMesh mesh, MMG5_int k); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param k triangle index. * \return 1. * @@ -841,7 +870,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Unset_parallelTriangle(MMG5_pMesh mesh, MMG5_int k); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param parIdx table of the indices of the parallel trias. * \param npar number of triangles between processors. * \return 1. @@ -861,7 +890,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Set_parallelTriangles(MMG5_pMesh mesh, MMG5_int *parIdx, MMG5_int npar); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param parIdx table of the indices of the parallel trias. * \param npar number of triangles between processors. * \return 1. @@ -881,7 +910,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Unset_parallelTriangles(MMG5_pMesh mesh, MMG5_int *parIdx, MMG5_int npar); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param k edge index. * \return 1. * @@ -898,7 +927,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Set_ridge(MMG5_pMesh mesh, MMG5_int k); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param k edge index. * \return 1. * @@ -915,7 +944,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Unset_ridge(MMG5_pMesh mesh, MMG5_int k); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param k edge index. * \return 1. * @@ -932,7 +961,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Set_requiredEdge(MMG5_pMesh mesh, MMG5_int k); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param k edge index. * \return 1. * @@ -949,7 +978,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Unset_requiredEdge(MMG5_pMesh mesh, MMG5_int k); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param k point index * \param n0 x componant of the normal at point \a k. * \param n1 y componant of the normal at point \a k. @@ -972,7 +1001,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara double n2) ; /** - * \param met pointer toward the sol structure. + * \param met pointer to the sol structure. * \param s solution scalar value. * \param pos position of the solution in the mesh. * \return 0 if failed, 1 otherwise. @@ -991,7 +1020,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara */ LIBMMG3D_EXPORT int MMG3D_Set_scalarSol(MMG5_pSol met, double s,MMG5_int pos); /** - * \param met pointer toward the sol structure. + * \param met pointer to the sol structure. * \param s table of the scalar solutions values. * s[i-1] is the solution at vertex i. * \return 0 if failed, 1 otherwise. @@ -1008,7 +1037,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara */ LIBMMG3D_EXPORT int MMG3D_Set_scalarSols(MMG5_pSol met, double *s); /** - * \param met pointer toward the sol structure. + * \param met pointer to the sol structure. * \param vx x value of the vectorial solution. * \param vy y value of the vectorial solution. * \param vz z value of the vectorial solution. @@ -1030,7 +1059,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Set_vectorSol(MMG5_pSol met, double vx,double vy, double vz, MMG5_int pos); /** - * \param met pointer toward the sol structure. + * \param met pointer to the sol structure. * \param sols table of the vectorial solutions * sols[3*(i-1)]\@3 is the solution at vertex i * \return 0 if failed, 1 otherwise. @@ -1047,7 +1076,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara */ LIBMMG3D_EXPORT int MMG3D_Set_vectorSols(MMG5_pSol met, double *sols); /** - * \param met pointer toward the sol structure. + * \param met pointer to the sol structure. * \param m11 value of the tensorial solution at position (1,1) in the tensor * \param m12 value of the tensorial solution at position (1,2) in the tensor * \param m13 value of the tensorial solution at position (1,3) in the tensor @@ -1072,7 +1101,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Set_tensorSol(MMG5_pSol met, double m11,double m12, double m13, double m22,double m23, double m33, MMG5_int pos); /** - * \param met pointer toward the sol structure. + * \param met pointer to the sol structure. * \param sols table of the tensorial solutions. * sols[6*(i-1)]\@6 is the solution at vertex i * \return 0 if failed, 1 otherwise. @@ -1089,7 +1118,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara */ LIBMMG3D_EXPORT int MMG3D_Set_tensorSols(MMG5_pSol met, double *sols); /** - * \param sol pointer toward the array of solutions + * \param sol pointer to the array of solutions * \param i position of the solution field that we want to set. * \param s solution(s) at mesh vertex \a pos. * \param pos index of the vertex on which we set the solution. @@ -1112,7 +1141,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara */ LIBMMG3D_EXPORT int MMG3D_Set_ithSol_inSolsAtVertices(MMG5_pSol sol,int i, double* s,MMG5_int pos); /** - * \param sol pointer toward the array of solutions + * \param sol pointer to the array of solutions * \param i position of the solution field that we want to set. * \param s table of the solutions at mesh vertices. The solution at vertex \a k * is given by s[k-1] for a scalar sol, s[3*(k-1)]\@3 for a vectorial solution @@ -1135,7 +1164,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Set_ithSols_inSolsAtVertices(MMG5_pSol sol,int i, double* s); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * * To mark as ended a mesh given without using the API functions * (for example, mesh given by mesh->point[i] = 0 ...). Not recommanded. @@ -1150,8 +1179,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara /* check init */ /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the sol structure. * \return 0 if failed, 1 otherwise. * * Check if the number of given entities match with mesh and sol size @@ -1168,8 +1197,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara /** functions to set parameters */ /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure (unused). + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure (unused). * \param iparam integer parameter to set (see \a MMG3D_Param structure). * \param val value for the parameter. * \return 0 if failed, 1 otherwise. @@ -1189,8 +1218,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Set_iparameter(MMG5_pMesh mesh,MMG5_pSol sol, int iparam, MMG5_int val); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure (unused). + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure (unused). * \param dparam double parameter to set (see \a MMG3D_Param structure). * \param val value of the parameter. * \return 0 if failed, 1 otherwise. @@ -1210,8 +1239,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Set_dparameter(MMG5_pMesh mesh,MMG5_pSol sol, int dparam, double val); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure. * \param typ type of entity (triangle, edge,...). * \param ref reference of the entity. * \param hmin minimal edge size. @@ -1237,8 +1266,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara MMG5_int ref,double hmin,double hmax,double hausd); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure. * \param ref input tetra reference. * \param split MMG5_MMAT_NoSplit if the entity must not be splitted, MMG5_MMAT_Split otherwise * \param rin internal reference after ls discretization @@ -1260,8 +1289,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara MMG5_int rin, MMG5_int rex); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure. * \param br new level-set base reference. * \return 0 if failed, 1 otherwise. * @@ -1283,13 +1312,13 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM /** recover datas */ /** - * \param mesh pointer toward the mesh structure. - * \param np pointer toward the number of vertices. - * \param ne pointer toward the number of tetrahedra. - * \param nprism pointer toward the number of prisms. - * \param nt pointer toward the number of triangles. - * \param nquad pointer toward the number of quads. - * \param na pointer toward the number of edges. + * \param mesh pointer to the mesh structure. + * \param np pointer to the number of vertices. + * \param ne pointer to the number of tetrahedra. + * \param nprism pointer to the number of prisms. + * \param nt pointer to the number of triangles. + * \param nquad pointer to the number of quads. + * \param na pointer to the number of edges. * \return 1. * * Get the number of vertices, tetrahedra, prisms, triangles, quadrilaterals and @@ -1306,12 +1335,12 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG3D_EXPORT int MMG3D_Get_meshSize(MMG5_pMesh mesh, MMG5_int* np, MMG5_int* ne,MMG5_int *nprism, MMG5_int* nt, MMG5_int* nquad, MMG5_int* na); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure. - * \param typEntity pointer toward the type of entities to which solutions + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure. + * \param typEntity pointer to the type of entities to which solutions * are applied. - * \param np pointer toward the number of solutions. - * \param typSol pointer toward the type of the solutions (scalar, vectorial, + * \param np pointer to the number of solutions. + * \param typSol pointer to the type of the solutions (scalar, vectorial, * ...) * \return 1. * @@ -1329,10 +1358,10 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG3D_EXPORT int MMG3D_Get_solSize(MMG5_pMesh mesh, MMG5_pSol sol, int* typEntity, MMG5_int* np,int* typSol); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward an array of sol structure. - * \param nsols pointer toward the number of solutions per entity. - * \param nentities pointer toward the number of solutions. + * \param mesh pointer to the mesh structure. + * \param sol pointer to an array of sol structure. + * \param nsols pointer to the number of solutions per entity. + * \param nentities pointer to the number of solutions. * \param typSol array of size MMG5_NSOLS_MAX to store type of each solution * (scalar, vector..). * @@ -1353,16 +1382,16 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG3D_EXPORT int MMG3D_Get_solsAtVerticesSize(MMG5_pMesh mesh, MMG5_pSol* sol,int *nsols, MMG5_int* nentities,int* typSol); /** - * \param mesh pointer toward the mesh structure. - * \param c0 pointer toward the coordinate of the point along the first + * \param mesh pointer to the mesh structure. + * \param c0 pointer to the coordinate of the point along the first * dimension. - * \param c1 pointer toward the coordinate of the point along the second + * \param c1 pointer to the coordinate of the point along the second * dimension. - * \param c2 pointer toward the coordinate of the point along the third + * \param c2 pointer to the coordinate of the point along the third * dimension. * \param ref pointer to the point reference. - * \param isCorner pointer toward the flag saying if point is corner. - * \param isRequired pointer toward the flag saying if point is required. + * \param isCorner pointer to the flag saying if point is corner. + * \param isRequired pointer to the flag saying if point is required. * \return 1. * * Get coordinates \a c0, \a c1,\a c2 and reference \a ref of next @@ -1383,13 +1412,13 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM MMG5_int* ref,int* isCorner, int* isRequired); /** - * \param mesh pointer toward the mesh structure. - * \param c0 pointer toward the coordinate of the point along the first dimension. - * \param c1 pointer toward the coordinate of the point along the second dimension. - * \param c2 pointer toward the coordinate of the point along the third dimension. + * \param mesh pointer to the mesh structure. + * \param c0 pointer to the coordinate of the point along the first dimension. + * \param c1 pointer to the coordinate of the point along the second dimension. + * \param c2 pointer to the coordinate of the point along the third dimension. * \param ref pointer to the point reference. - * \param isCorner pointer toward the flag saying if point is corner. - * \param isRequired pointer toward the flag saying if point is required. + * \param isCorner pointer to the flag saying if point is corner. + * \param isRequired pointer to the flag saying if point is required. * \param idx index of point to get. * \return 1. * @@ -1410,16 +1439,16 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM int* isCorner, int* isRequired,MMG5_int idx); /** - * \param mesh pointer toward the mesh structure. - * \param vertices pointer toward the table of the points coordinates. + * \param mesh pointer to the mesh structure. + * \param vertices pointer to the table of the points coordinates. * The coordinates of the \f$i^{th}\f$ point are stored in * vertices[(i-1)*3]\@3. * \param refs pointer to the table of the point references. * The ref of the \f$i^th\f$ point is stored in refs[i-1]. - * \param areCorners pointer toward the table of the flags saying if + * \param areCorners pointer to the table of the flags saying if * points are corners. * areCorners[i-1]=1 if the \f$i^{th}\f$ point is corner. - * \param areRequired pointer toward the table of flags saying if points + * \param areRequired pointer to the table of flags saying if points * are required. areRequired[i-1]=1 if the \f$i^{th}\f$ point is required. * \return 1. * @@ -1441,13 +1470,13 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG3D_EXPORT int MMG3D_Get_vertices(MMG5_pMesh mesh, double* vertices, MMG5_int* refs, int* areCorners, int* areRequired); /** - * \param mesh pointer toward the mesh structure. - * \param v0 pointer toward the first vertex of tetrahedron. - * \param v1 pointer toward the second vertex of tetrahedron. - * \param v2 pointer toward the third vertex of tetrahedron. - * \param v3 pointer toward the fourth vertex of tetrahedron. - * \param ref pointer toward the tetrahedron reference. - * \param isRequired pointer toward the flag saying if tetrahedron is + * \param mesh pointer to the mesh structure. + * \param v0 pointer to the first vertex of tetrahedron. + * \param v1 pointer to the second vertex of tetrahedron. + * \param v2 pointer to the third vertex of tetrahedron. + * \param v3 pointer to the fourth vertex of tetrahedron. + * \param ref pointer to the tetrahedron reference. + * \param isRequired pointer to the flag saying if tetrahedron is * required. * \return 0 if failed, 1 otherwise. * @@ -1468,12 +1497,12 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG3D_EXPORT int MMG3D_Get_tetrahedron(MMG5_pMesh mesh, MMG5_int* v0, MMG5_int* v1, MMG5_int* v2, MMG5_int* v3,MMG5_int* ref, int* isRequired); /** - * \param mesh pointer toward the mesh structure. - * \param tetra pointer toward the table of the tetrahedra vertices. + * \param mesh pointer to the mesh structure. + * \param tetra pointer to the table of the tetrahedra vertices. * Vertices of the \f$i^{th}\f$ tetra are stored in tetra[(i-1)*4]\@4. - * \param refs pointer toward the table of the tetrahedron references. + * \param refs pointer to the table of the tetrahedron references. * References of the \f$i^{th}\f$ tetra is stored in refs[i-1]. - * \param areRequired pointer toward the table of the flags saying if the + * \param areRequired pointer to the table of the flags saying if the * tetrahedra are required. areRequired[i-1]=1 if the \f$i^{th}\f$ tetra * is required. * \return 0 if failed, 1 otherwise. @@ -1496,15 +1525,15 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG3D_EXPORT int MMG3D_Get_tetrahedra(MMG5_pMesh mesh, MMG5_int* tetra,MMG5_int* refs, int* areRequired); /** - * \param mesh pointer toward the mesh structure. - * \param v0 pointer toward the first vertex of prism. - * \param v1 pointer toward the second vertex of prism. - * \param v2 pointer toward the third vertex of prism. - * \param v3 pointer toward the fourth vertex of prism. - * \param v4 pointer toward the fifth vertex of prism. - * \param v5 pointer toward the sixth vertex of prism. - * \param ref pointer toward the prism reference. - * \param isRequired pointer toward the flag saying if prism is + * \param mesh pointer to the mesh structure. + * \param v0 pointer to the first vertex of prism. + * \param v1 pointer to the second vertex of prism. + * \param v2 pointer to the third vertex of prism. + * \param v3 pointer to the fourth vertex of prism. + * \param v4 pointer to the fifth vertex of prism. + * \param v5 pointer to the sixth vertex of prism. + * \param ref pointer to the prism reference. + * \param isRequired pointer to the flag saying if prism is * required. * \return 0 if failed, 1 otherwise. * @@ -1525,12 +1554,12 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG3D_EXPORT int MMG3D_Get_prism(MMG5_pMesh mesh, MMG5_int* v0, MMG5_int* v1, MMG5_int* v2, MMG5_int* v3,MMG5_int* v4,MMG5_int* v5,MMG5_int* ref, int* isRequired); /** - * \param mesh pointer toward the mesh structure. - * \param prisms pointer toward the table of the prisms vertices. + * \param mesh pointer to the mesh structure. + * \param prisms pointer to the table of the prisms vertices. * Vertices of the \f$i^{th}\f$ prism are stored in prisms[(i-1)*6]\@6. - * \param refs pointer toward the table of the prism references. + * \param refs pointer to the table of the prism references. * References of the \f$i^{th}\f$ prism is stored in refs[i-1]. - * \param areRequired pointer toward the table of the flags saying if the + * \param areRequired pointer to the table of the flags saying if the * prisms are required. areRequired[i-1]=1 if the \f$i^{th}\f$ prism * is required. * \return 0 if failed, 1 otherwise. @@ -1553,12 +1582,12 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG3D_EXPORT int MMG3D_Get_prisms(MMG5_pMesh mesh, MMG5_int* prisms,MMG5_int* refs, int* areRequired); /** - * \param mesh pointer toward the mesh structure. - * \param v0 pointer toward the first vertex of triangle. - * \param v1 pointer toward the second vertex of triangle. - * \param v2 pointer toward the third vertex of triangle. - * \param ref pointer toward the triangle reference. - * \param isRequired pointer toward the flag saying if triangle is required. + * \param mesh pointer to the mesh structure. + * \param v0 pointer to the first vertex of triangle. + * \param v1 pointer to the second vertex of triangle. + * \param v2 pointer to the third vertex of triangle. + * \param ref pointer to the triangle reference. + * \param isRequired pointer to the flag saying if triangle is required. * \return 0 if failed, 1 otherwise. * * Get vertices \a v0,\a v1,\a v2 and reference \a ref of next @@ -1577,12 +1606,12 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG3D_EXPORT int MMG3D_Get_triangle(MMG5_pMesh mesh, MMG5_int* v0, MMG5_int* v1, MMG5_int* v2, MMG5_int* ref, int* isRequired); /** - * \param mesh pointer toward the mesh structure. - * \param tria pointer toward the table of the triangles vertices + * \param mesh pointer to the mesh structure. + * \param tria pointer to the table of the triangles vertices * Vertices of the \f$i^{th}\f$ tria are stored in tria[(i-1)*3]\@3. - * \param refs pointer toward the table of the triangles references. + * \param refs pointer to the table of the triangles references. * refs[i-1] is the ref of the \f$i^{th}\f$ tria. - * \param areRequired pointer toward table of the flags saying if triangles + * \param areRequired pointer to table of the flags saying if triangles * are required. areRequired[i-1]=1 if the \f$i^{th}\f$ tria * is required. * \return 0 if failed, 1 otherwise. @@ -1604,13 +1633,13 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG3D_EXPORT int MMG3D_Get_triangles(MMG5_pMesh mesh, MMG5_int* tria, MMG5_int* refs, int* areRequired); /** - * \param mesh pointer toward the mesh structure. - * \param v0 pointer toward the first vertex of quadrilateral. - * \param v1 pointer toward the second vertex of quadrilateral. - * \param v2 pointer toward the third vertex of quadrilateral. - * \param v3 pointer toward the fourth vertex of quadrilateral. - * \param ref pointer toward the quadrilateral reference. - * \param isRequired pointer toward the flag saying if quadrilateral is required. + * \param mesh pointer to the mesh structure. + * \param v0 pointer to the first vertex of quadrilateral. + * \param v1 pointer to the second vertex of quadrilateral. + * \param v2 pointer to the third vertex of quadrilateral. + * \param v3 pointer to the fourth vertex of quadrilateral. + * \param ref pointer to the quadrilateral reference. + * \param isRequired pointer to the flag saying if quadrilateral is required. * \return 0 if failed, 1 otherwise. * * Get vertices \a v0,\a v1,\a v2,\a v3 and reference \a ref of next @@ -1628,12 +1657,12 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG3D_EXPORT int MMG3D_Get_quadrilateral(MMG5_pMesh mesh, MMG5_int* v0, MMG5_int* v1, MMG5_int* v2,MMG5_int* v3, MMG5_int* ref, int* isRequired); /** - * \param mesh pointer toward the mesh structure. - * \param quads pointer toward the table of the quadrilaterals vertices + * \param mesh pointer to the mesh structure. + * \param quads pointer to the table of the quadrilaterals vertices * Vertices of the \f$i^{th}\f$ quadra are stored in tria[(i-1)*4]\@4. - * \param refs pointer toward the table of the quadrilaterals references. + * \param refs pointer to the table of the quadrilaterals references. * refs[i-1] is the ref of the \f$i^{th}\f$ quadra. - * \param areRequired pointer toward table of the flags saying if quadrilaterals + * \param areRequired pointer to table of the flags saying if quadrilaterals * are required. areRequired[i-1]=1 if the \f$i^{th}\f$ quadra * is required. * \return 0 if failed, 1 otherwise. @@ -1655,12 +1684,12 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG3D_EXPORT int MMG3D_Get_quadrilaterals(MMG5_pMesh mesh, MMG5_int* quads, MMG5_int* refs, int* areRequired); /** - * \param mesh pointer toward the mesh structure. - * \param e0 pointer toward the first extremity of the edge. - * \param e1 pointer toward the second extremity of the edge. - * \param ref pointer toward the edge reference. - * \param isRidge pointer toward the flag saying if the edge is ridge. - * \param isRequired pointer toward the flag saying if the edge is required. + * \param mesh pointer to the mesh structure. + * \param e0 pointer to the first extremity of the edge. + * \param e1 pointer to the second extremity of the edge. + * \param ref pointer to the edge reference. + * \param isRidge pointer to the flag saying if the edge is ridge. + * \param isRequired pointer to the flag saying if the edge is required. * \return 0 if failed, 1 otherwise. * * Get extremities \a e0, \a e1 and reference \a ref of next edge of mesh. @@ -1678,8 +1707,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG3D_EXPORT int MMG3D_Get_edge(MMG5_pMesh mesh, MMG5_int* e0, MMG5_int* e1, MMG5_int* ref, int* isRidge, int* isRequired); /** - * \param mesh pointer toward the mesh structure. - * \param edges pointer toward the array of edges. + * \param mesh pointer to the mesh structure. + * \param edges pointer to the array of edges. * Vertices of the \f$i^{th}\f$ edge are stored in edge[(i-1)*2]\@2. * \param refs edges references. refs[i-1] is the ref of the \f$i^{th}\f$ edge. * \return 0 if failed, 1 otherwise. @@ -1697,8 +1726,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG3D_EXPORT int MMG3D_Set_edges(MMG5_pMesh mesh, MMG5_int *edges, MMG5_int* refs); /** - * \param mesh pointer toward the mesh structure. - * \param edges pointer toward the array of edges. + * \param mesh pointer to the mesh structure. + * \param edges pointer to the array of edges. * Vertices of the \f$i^{th}\f$ edge are stored in edge[(i-1)*2]\@2. * \param refs edges references. refs[i-1] is the ref of the \f$i^{th}\f$ edge. * \param areRidges 1 if the edge is a ridge, 0 otherwise. @@ -1720,7 +1749,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG3D_EXPORT int MMG3D_Get_edges(MMG5_pMesh mesh,MMG5_int *edges,MMG5_int* refs, int *areRidges,int *areRequired); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param k point index * \param n0 x componant of the normal at point \a k. * \param n1 y componant of the normal at point \a k. @@ -1743,8 +1772,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM double *n2) ; /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k index of the tetra for which we want to get the quality. * \return the computed quality or 0. if fail. * @@ -1761,8 +1790,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG3D_EXPORT double MMG3D_Get_tetrahedronQuality(MMG5_pMesh mesh,MMG5_pSol met, MMG5_int k); /** - * \param met pointer toward the sol structure. - * \param s pointer toward the scalar solution value. + * \param met pointer to the sol structure. + * \param s pointer to the scalar solution value. * \return 0 if failed, 1 otherwise. * * Get solution \a s of next vertex of mesh. @@ -1777,7 +1806,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG3D_EXPORT int MMG3D_Get_scalarSol(MMG5_pSol met, double* s); /** - * \param met pointer toward the sol structure. + * \param met pointer to the sol structure. * \param s table of the scalar solutions at mesh vertices. s[i-1] is * the solution at vertex i. * \return 0 if failed, 1 otherwise. @@ -1794,7 +1823,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG3D_EXPORT int MMG3D_Get_scalarSols(MMG5_pSol met, double* s); /** - * \param met pointer toward the sol structure. + * \param met pointer to the sol structure. * \param vx x value of the vectorial solution. * \param vy y value of the vectorial solution. * \param vz z value of the vectorial solution. @@ -1812,7 +1841,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG3D_EXPORT int MMG3D_Get_vectorSol(MMG5_pSol met, double* vx, double* vy, double* vz); /** - * \param met pointer toward the sol structure. + * \param met pointer to the sol structure. * \param sols table of the solutions at mesh vertices. sols[3*(i-1)]\@3 is * the solution at vertex i. * \return 0 if failed, 1 otherwise. @@ -1829,13 +1858,13 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG3D_EXPORT int MMG3D_Get_vectorSols(MMG5_pSol met, double* sols); /** - * \param met pointer toward the sol structure. - * \param m11 pointer toward the position (1,1) in the solution tensor. - * \param m12 pointer toward the position (1,2) in the solution tensor. - * \param m13 pointer toward the position (1,3) in the solution tensor. - * \param m22 pointer toward the position (2,2) in the solution tensor. - * \param m23 pointer toward the position (2,3) in the solution tensor. - * \param m33 pointer toward the position (3,3) in the solution tensor. + * \param met pointer to the sol structure. + * \param m11 pointer to the position (1,1) in the solution tensor. + * \param m12 pointer to the position (1,2) in the solution tensor. + * \param m13 pointer to the position (1,3) in the solution tensor. + * \param m22 pointer to the position (2,2) in the solution tensor. + * \param m23 pointer to the position (2,3) in the solution tensor. + * \param m33 pointer to the position (3,3) in the solution tensor. * \return 0 if failed, 1 otherwise. * * Get tensorial solution of next vertex of mesh. @@ -1851,7 +1880,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG3D_EXPORT int MMG3D_Get_tensorSol(MMG5_pSol met, double *m11,double *m12, double *m13, double *m22,double *m23, double *m33); /** - * \param met pointer toward the sol structure. + * \param met pointer to the sol structure. * \param sols table of the solutions at mesh vertices. * sols[6*(i-1)]\@6 is the solution at vertex i. * \return 0 if failed, 1 otherwise. @@ -1868,7 +1897,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG3D_EXPORT int MMG3D_Get_tensorSols(MMG5_pSol met, double *sols); /** - * \param sol pointer toward the array of solutions + * \param sol pointer to the array of solutions * \param i position of the solution field that we want to get. * \param s solution(s) at mesh vertex \a pos. * \param pos index of the vertex on which we get the solution. @@ -1890,7 +1919,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG3D_EXPORT int MMG3D_Get_ithSol_inSolsAtVertices(MMG5_pSol sol,int i, double* s,MMG5_int pos); /** - * \param sol pointer toward the array of solutions + * \param sol pointer to the array of solutions * \param i position of the solution field that we want to get. * \param s table of the solutions at mesh vertices. The solution at vertex \a k * is given by s[k-1] for a scalar sol, s[3*(k-1)]\@3 for a vectorial solution @@ -1913,7 +1942,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG3D_EXPORT int MMG3D_Get_ithSols_inSolsAtVertices(MMG5_pSol sol,int i, double* s); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param iparam integer parameter to set (see \a MMG3D_Param structure). * \return The value of integer parameter. * @@ -1930,7 +1959,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG3D_EXPORT int MMG3D_Get_iparameter(MMG5_pMesh mesh, MMG5_int iparam); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param v0 first vertex of tetrahedron. * \param v1 second vertex of tetrahedron. * \param v2 third vertex of tetrahedron. @@ -1956,7 +1985,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM MMG5_int v2, MMG5_int v3, MMG5_int ref); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param c0 x coor of the new point * \param c1 y coor of the new point * \param c2 z coor of the new point @@ -1982,7 +2011,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM /* input/output functions */ /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param filename name of file. * * \return 0 if file is not found, -1 if fail for another reason (mem lack, file @@ -2001,8 +2030,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG3D_EXPORT int MMG3D_loadMesh(MMG5_pMesh mesh,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solution structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solution structure. * \param filename name of file. * * \return 0 if file is not found, -1 if fail for another reason (mem lack, file @@ -2023,9 +2052,9 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG3D_EXPORT int MMG3D_loadMshMesh(MMG5_pMesh mesh,MMG5_pSol sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure or the NULL pointer. - * \param sol pointer toward the level-set structure or the NULL pointer. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure or the NULL pointer. + * \param sol pointer to the level-set structure or the NULL pointer. * \param filename name of file. * * \return 0 if file is not found, -1 if fail for another reason (mem lack, file @@ -2048,8 +2077,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG3D_EXPORT int MMG3D_loadVtuMesh(MMG5_pMesh mesh,MMG5_pSol met,MMG5_pSol sol,const char *filename); /** * \param - * \met,mesh pointer toward the mesh structure. - * \param sol pointer toward the solution structure. + * \met,mesh pointer to the mesh structure. + * \param sol pointer to the solution structure. * \param filename name of file. * * \return 0 if file is not found, -1 if fail for another reason (mem lack, file @@ -2072,9 +2101,9 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure or the NULL pointer. - * \param sol pointer toward the level-set structure or the NULL pointer. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure or the NULL pointer. + * \param sol pointer to the level-set structure or the NULL pointer. * \param filename name of file. * * \return 0 if file is not found, -1 if fail for another reason (mem lack, file @@ -2096,8 +2125,8 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol */ LIBMMG3D_EXPORT int MMG3D_loadVtkMesh(MMG5_pMesh mesh,MMG5_pSol met,MMG5_pSol sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solution structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solution structure. * \param filename name of file. * * \return 0 if file is not found, -1 if fail for another reason (mem lack, file @@ -2120,8 +2149,8 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT int MMG3D_loadVtkMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward a list of solution structures. + * \param mesh pointer to the mesh structure. + * \param sol pointer to a list of solution structures. * \param filename name of file. * * \return 0 if file is not found, -1 if fail for another reason (mem lack, file @@ -2142,9 +2171,9 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT int MMG3D_loadMshMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure or the NULL pointer. - * \param sol pointer toward the level-set structure or the NULL pointer. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure or the NULL pointer. + * \param sol pointer to the level-set structure or the NULL pointer. * \param filename name of file. * * \return 0 if file is not found, -1 if fail for another reason (mem lack, file @@ -2164,8 +2193,8 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT int MMG3D_loadGenericMesh(MMG5_pMesh mesh,MMG5_pSol met,MMG5_pSol sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param filename pointer toward the name of file. + * \param mesh pointer to the mesh structure. + * \param filename pointer to the name of file. * \return 0 if failed, 1 otherwise. * @@ -2182,8 +2211,8 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol */ LIBMMG3D_EXPORT int MMG3D_saveMesh(MMG5_pMesh mesh, const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solution structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solution structure. * \param filename name of file. * \return 0 if failed, 1 otherwise. * @@ -2202,8 +2231,8 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT int MMG3D_saveMshMesh(MMG5_pMesh mesh,MMG5_pSol sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solution structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solution structure. * \param filename name of file. * \return 0 if failed, 1 otherwise. * @@ -2223,8 +2252,8 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol */ LIBMMG3D_EXPORT int MMG3D_saveMshMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solution structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solution structure. * \param filename name of file. * \return 0 if failed, 1 otherwise. * @@ -2241,8 +2270,8 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol */ LIBMMG3D_EXPORT int MMG3D_saveVtkMesh(MMG5_pMesh mesh,MMG5_pSol sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solution structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solution structure. * \param filename name of file. * \return 0 if failed, 1 otherwise. * @@ -2259,8 +2288,8 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol */ LIBMMG3D_EXPORT int MMG3D_saveVtkMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solution structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solution structure. * \param filename name of file. * \return 0 if failed, 1 otherwise. * @@ -2277,8 +2306,8 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol */ LIBMMG3D_EXPORT int MMG3D_saveVtuMesh(MMG5_pMesh mesh,MMG5_pSol sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solution structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solution structure. * \param filename name of file. * \return 0 if failed, 1 otherwise. * @@ -2296,7 +2325,7 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT int MMG3D_saveVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param filename name of the readed file. * \return 0 or -1 if fail, 1 otherwise. * @@ -2314,7 +2343,7 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT int MMG3D_saveTetgenMesh(MMG5_pMesh ,const char *); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param filename name of file. * \return 0 if failed, 1 otherwise. * @@ -2332,8 +2361,8 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT int MMG3D_saveGenericMesh(MMG5_pMesh mesh,MMG5_pSol sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the sol structure. * \param filename name of file. * * \return 0 if file is not found, -1 if fail for another reason (mem lack, file @@ -2353,8 +2382,8 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol */ LIBMMG3D_EXPORT int MMG3D_loadSol(MMG5_pMesh mesh,MMG5_pSol met, const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solutions array + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solutions array * \param filename name of file. * * \return 0 if file is not found, -1 if fail for another reason (mem lack, file @@ -2374,8 +2403,8 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT int MMG3D_loadAllSols(MMG5_pMesh mesh,MMG5_pSol *sol, const char* filename); /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the sol structure. * \param filename name of file. * \return 0 if failed, 1 otherwise. * @@ -2392,8 +2421,8 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol */ LIBMMG3D_EXPORT int MMG3D_saveSol(MMG5_pMesh mesh,MMG5_pSol met, const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solutions array + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solutions array * \param filename name of the solution file. * \return 0 or -1 if fail, 1 otherwise. * @@ -2411,8 +2440,8 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT int MMG3D_saveAllSols(MMG5_pMesh mesh,MMG5_pSol *sol ,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward an array of solution structure (that stores solution fields). + * \param mesh pointer to the mesh structure. + * \param sol pointer to an array of solution structure (that stores solution fields). * \return 1 * * Deallocation of an array of solution fields @@ -2530,8 +2559,8 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol /* library */ /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the sol (metric) structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the sol (metric) structure. * \return \ref MMG5_SUCCESS if success, \ref MMG5_LOWFAILURE if fail but a * conform mesh is saved or \ref MMG5_STRONGFAILURE if fail and we can't save * the mesh. @@ -2548,9 +2577,9 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT int MMG3D_mmg3dlib(MMG5_pMesh mesh, MMG5_pSol met ); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol (level-set) structure. - * \param met pointer toward a sol structure (metric), optionnal. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol (level-set) structure. + * \param met pointer to a sol structure (metric), optionnal. * \return \ref MMG5_SUCCESS if success, \ref MMG5_LOWFAILURE if fail but a * conform mesh is saved or \ref MMG5_STRONGFAILURE if fail and we can't save * the mesh. @@ -2569,9 +2598,9 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT int MMG3D_mmg3dls(MMG5_pMesh mesh, MMG5_pSol sol, MMG5_pSol met ); /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the sol (output metric) structure. - * \param disp pointer toward a sol (displacement for the lagrangian motion + * \param mesh pointer to the mesh structure. + * \param met pointer to the sol (output metric) structure. + * \param disp pointer to a sol (displacement for the lagrangian motion * mode) structure. * \return \ref MMG5_SUCCESS if success, \ref MMG5_LOWFAILURE if fail but a * conform mesh is saved or \ref MMG5_STRONGFAILURE if fail and we can't save @@ -2590,7 +2619,7 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol /** Tools for the library */ /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \return 0 if fail, 1 if success. * * Print the default parameters values. @@ -2607,9 +2636,9 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol /** * \param argc number of command line arguments. * \param argv command line arguments. - * \param mesh pointer toward the mesh structure. - * \param met pointer toward a metric - * \param sol pointer toward a level-set or displacement + * \param mesh pointer to the mesh structure. + * \param met pointer to a metric + * \param sol pointer to a level-set or displacement * \return 1 if we want to run Mmg after, 0 if not or if fail. * * Store command line arguments. @@ -2620,8 +2649,8 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT int MMG3D_parsar(int argc,char *argv[],MMG5_pMesh mesh,MMG5_pSol met,MMG5_pSol sol); /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the sol structure. * \return 1. * * Read local parameters file. This file must have the same name as @@ -2637,7 +2666,7 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol */ LIBMMG3D_EXPORT int MMG3D_parsop(MMG5_pMesh mesh,MMG5_pSol met); /** - * \param prog pointer toward the program name. + * \param prog pointer to the program name. * \param return 1 if success, 0 if fail. * * Print help for mmg3d options. @@ -2652,8 +2681,8 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol */ LIBMMG3D_EXPORT int MMG3D_usage(char *prog); /** - * \param mesh pointer toward the mesh structure. - * \param info pointer toward the info structure. + * \param mesh pointer to the mesh structure. + * \param info pointer to the info structure. * \return 1. * * Store the info structure in the mesh structure. @@ -2667,8 +2696,8 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol */ LIBMMG3D_EXPORT int MMG3D_stockOptions(MMG5_pMesh mesh, MMG5_Info *info); /** - * \param mesh pointer toward the mesh structure. - * \param info pointer toward the info structure. + * \param mesh pointer to the mesh structure. + * \param info pointer to the info structure. * * Recover the info structure stored in the mesh structure. * @@ -2682,9 +2711,9 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol /** Checks */ /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the sol structure (metric). - * \param sol pointer toward the sol structure (ls or displacement). + * \param mesh pointer to the mesh structure. + * \param met pointer to the sol structure (metric). + * \param sol pointer to the sol structure (ls or displacement). * \param critmin minimum quality for elements. * \param lmin minimum edge length. * \param lmax maximum ede length. @@ -2708,10 +2737,10 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT int MMG3D_mmg3dcheck(MMG5_pMesh mesh,MMG5_pSol met,MMG5_pSol sol,double critmin, double lmin, double lmax, MMG5_int *eltab,int8_t metRidTyp); /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the sol structure. * \param critmin minimum quality for elements. - * \param eltab pointer toward the table of invalid elements. + * \param eltab pointer to the table of invalid elements. * \param metRidTyp Type of storage of ridges metrics: 0 for classic storage * (before the MMG5_defsiz call), 1 for special storage (after this call). * @@ -2730,8 +2759,8 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT void MMG3D_searchqua(MMG5_pMesh mesh, MMG5_pSol met, double critmin, MMG5_int *eltab,int8_t metRidTyp); /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the sol structure. * \param lmin minimum edge length. * \param lmax maximum ede length. * \param eltab table of invalid elements. @@ -2761,9 +2790,9 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol /** Utils */ /** * \brief Return adjacent elements of a tetrahedron. - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param kel tetrahedron index. - * \param listet pointer toward the table of the 4 tetra adjacent to \a kel. + * \param listet pointer to the table of the 4 tetra adjacent to \a kel. * (the index is 0 if there is no adjacent) * \return 1. * @@ -2782,11 +2811,11 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol */ LIBMMG3D_EXPORT int MMG3D_Get_adjaTet(MMG5_pMesh mesh,MMG5_int kel, MMG5_int listet[4]); /** - * \param ca pointer toward the coordinates of the first edge's extremity. - * \param cb pointer toward the coordinates of the second edge's extremity. - * \param ma pointer toward the metric associated to the first edge's + * \param ca pointer to the coordinates of the first edge's extremity. + * \param cb pointer to the coordinates of the second edge's extremity. + * \param ma pointer to the metric associated to the first edge's * extremity. - * \param mb pointer toward the metric associated to the second edge's + * \param mb pointer to the metric associated to the second edge's * extremity. * \return edge length. * @@ -2804,7 +2833,7 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT extern double (*MMG3D_lenedgCoor)(double *ca,double *cb,double *sa,double *sb); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param pack we pack the mesh at function begining if \f$pack=1\f$. * \return 0 if failed, 1 otherwise. * @@ -2822,8 +2851,8 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT int MMG3D_hashTetra(MMG5_pMesh mesh, int pack); /** - * \param mesh pointer toward the mesh structure - * \param met pointer toward the sol structure + * \param mesh pointer to the mesh structure + * \param met pointer to the sol structure * \return 1 if success * * Compute isotropic size map according to the mean of the length of the @@ -2839,8 +2868,8 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT extern int (*MMG3D_doSol)(MMG5_pMesh mesh,MMG5_pSol met); /** - * \param mesh pointer toward the mesh structure - * \param met pointer toward the sol structure + * \param mesh pointer to the mesh structure + * \param met pointer to the sol structure * \return 1 if success * * Compute constant size map according to mesh->info.hsiz, mesh->info.hmin and @@ -2856,8 +2885,8 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT int MMG3D_Set_constantSize(MMG5_pMesh mesh,MMG5_pSol met); /** - * \param mesh pointer toward the mesh structure - * \param met pointer toward the sol structure + * \param mesh pointer to the mesh structure + * \param met pointer to the sol structure * \return 1 if success * * Switch the m22 and m23 value of the metric to allow to pass from the API @@ -2875,8 +2904,8 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol /** To associate function pointers without calling MMG3D_mmg3dlib */ /** - * \param mesh pointer toward the mesh structure (unused). - * \param met pointer toward the sol structure (unused). + * \param mesh pointer to the mesh structure (unused). + * \param met pointer to the sol structure (unused). * * Set function pointers for caltet, lenedg, lenedgCoor defsiz, gradsiz... * depending if the readed metric is anisotropic or isotropic @@ -2890,8 +2919,8 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT void MMG3D_setfunc(MMG5_pMesh mesh,MMG5_pSol met); /** - * \param mesh pointer toward the mesh structure. - * \param nb_tria pointer toward the number of non boundary triangles. + * \param mesh pointer to the mesh structure. + * \param nb_tria pointer to the number of non boundary triangles. * \return 0 if failed, 1 otherwise. * * Get the number of non boundary triangles (for DG methods for example). @@ -2914,11 +2943,11 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT int MMG3D_Get_numberOfNonBdyTriangles(MMG5_pMesh mesh, MMG5_int* nb_tria); /** - * \param mesh pointer toward the mesh structure. - * \param v0 pointer toward the firts vertex of the triangle - * \param v1 pointer toward the second vertex of the triangle. - * \param v2 pointer toward the third vertex of the triangle. - * \param ref pointer toward the triangle reference. + * \param mesh pointer to the mesh structure. + * \param v0 pointer to the firts vertex of the triangle + * \param v1 pointer to the second vertex of the triangle. + * \param v2 pointer to the third vertex of the triangle. + * \param ref pointer to the triangle reference. * \param idx index of the non boundary triangle to get (between 1 and nb_tria) * \return 0 if failed, 1 otherwise. * @@ -2940,10 +2969,10 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT int MMG3D_Get_nonBdyTriangle(MMG5_pMesh mesh, MMG5_int* v0, MMG5_int* v1, MMG5_int* v2, MMG5_int* ref, MMG5_int idx); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param ktri index of the boundary triangle. - * \param ktet pointer toward an integer that will contains the tetra index. - * \param iface pointer toward the triangle in \a ktet. + * \param ktet pointer to an integer that will contains the tetra index. + * \param iface pointer to the triangle in \a ktet. * * \return 0 if fail, 1 otherwise * @@ -2965,11 +2994,11 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT int MMG3D_Get_tetFromTria(MMG5_pMesh mesh, MMG5_int ktri, MMG5_int *ktet, int *iface); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param ktri index of the boundary triangle. * \param ktet array of size 2 that will contain the indices of the tetra * (filled by the function). - * \param iface pointer toward an array of size 2 that will contains the indices + * \param iface pointer to an array of size 2 that will contains the indices * of the faces of the tetras \a ktet[i] that corresponds to the boundary tria * \a ktri. * @@ -2992,13 +3021,13 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT int MMG3D_Get_tetsFromTria(MMG5_pMesh mesh, MMG5_int ktri, MMG5_int ktet[2], int iface[2]); /** - * \param m upper part of a symetric matric diagonalizable in |R + * \param m upper part of a symmetric matric diagonalizable in |R * \param lambda array of the metric eigenvalues * \param vp array of the metric eigenvectors * * \return the order of the eigenvalues * - * Compute the real eigenvalues and eigenvectors of a symetric matrice m whose + * Compute the real eigenvalues and eigenvectors of a symmetric matrix m whose * upper part is provided (m11, m12, m13, m22, m23, m33 in this order). * lambda[0] is the eigenvalue associated to the eigenvector ( v[0][0], v[0,1], v[0,2] ) * in C and to the eigenvector v(1,:) in fortran @@ -3018,7 +3047,7 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT int MMG3D_Compute_eigenv(double m[6],double lambda[3],double vp[3][3]); /** - * \param mesh pointer toward mesh sructure + * \param mesh pointer to the mesh sructure * * \return 1 if successful, 0 otherwise. * @@ -3034,8 +3063,8 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT int MMG3D_Clean_isoSurf(MMG5_pMesh mesh); /** - * \param mesh pointer toward the mesh structure - * \param sol pointer toward the solution structure + * \param mesh pointer to the mesh structure + * \param sol pointer to the solution structure * * Free the solution. * From d95ee3c449f5c05d4d62b990f9d03d58b1a83787 Mon Sep 17 00:00:00 2001 From: Mark Potse Date: Sat, 2 Mar 2024 13:20:26 +0100 Subject: [PATCH 02/11] bulk-fixed a bunch of common typos in comments --- .../main.F90 | 6 +- .../IsosurfDiscretization_lsAndMetric/main.c | 6 +- .../main_hsiz.F90 | 4 +- .../main_hsiz.c | 4 +- .../main_optim.F90 | 4 +- .../main_optim.c | 4 +- .../IsosurfDiscretization_lsOnly/main.F90 | 4 +- .../mmg3d/IsosurfDiscretization_lsOnly/main.c | 4 +- .../main_hsiz.F90 | 4 +- .../IsosurfDiscretization_lsOnly/main_hsiz.c | 4 +- .../main_optim.F90 | 4 +- .../IsosurfDiscretization_lsOnly/main_optim.c | 4 +- .../mmg3d/LagrangianMotion_example0/main.c | 4 +- libexamples/mmg3d/adaptation_example1/main.c | 4 +- libexamples/mmg3d/adaptation_example2/main.c | 4 +- .../mmg3d/io_generic_and_get_adja/genericIO.c | 4 +- .../mmg3d/io_multisols_example6/main.F90 | 4 +- .../mmg3d/io_multisols_example6/main.c | 4 +- src/common/API_functions.c | 34 +- src/common/analys.c | 2 +- src/common/anisomovpt.c | 8 +- src/common/anisosiz.c | 84 ++-- src/common/apptools.c | 22 +- src/common/bezier.c | 2 +- src/common/boulep.c | 36 +- src/common/chrono.c | 6 +- src/common/eigenv.c | 10 +- src/common/hash.c | 28 +- src/common/inlined_functions_private.h | 14 +- src/common/inout.c | 72 +-- src/common/intmet.c | 10 +- src/common/isosiz.c | 34 +- src/common/libmmgcommon_private.h | 72 +-- src/common/librnbg.c | 20 +- src/common/libtools.c | 16 +- src/common/mettools.c | 60 +-- src/common/mmg2.c | 46 +- src/common/mmg2s.c | 6 +- src/common/mmg3.c | 10 +- src/common/quality.c | 30 +- src/common/scalem.c | 50 +- src/common/tools.c | 30 +- src/mmg2d/analys_2d.c | 14 +- src/mmg2d/anisosiz_2d.c | 24 +- src/mmg2d/boulep_2d.c | 4 +- src/mmg2d/chkmsh_2d.c | 2 +- src/mmg2d/colver_2d.c | 4 +- src/mmg2d/delone_2d.c | 8 +- src/mmg2d/enforcement_2d.c | 4 +- src/mmg2d/hash_2d.c | 14 +- src/mmg2d/inout_2d.c | 30 +- src/mmg2d/isosiz_2d.c | 12 +- src/mmg2d/libmmg2d.c | 2 +- src/mmg2d/libmmg2d.h | 452 +++++++++--------- src/mmg2d/libmmg2d_tools.c | 6 +- src/mmg2d/lissmet_2d.c | 4 +- src/mmg2d/locate_2d.c | 8 +- src/mmg2d/mmg2d.c | 18 +- src/mmg2d/mmg2d1.c | 14 +- src/mmg2d/mmg2d2.c | 14 +- src/mmg2d/mmg2d6.c | 6 +- src/mmg2d/mmg2d9.c | 22 +- src/mmg2d/movpt_2d.c | 12 +- src/mmg2d/quality_2d.c | 14 +- src/mmg2d/solmap_2d.c | 12 +- src/mmg2d/split_2d.c | 32 +- src/mmg2d/tools_2d.c | 6 +- src/mmg2d/variadic_2d.c | 38 +- src/mmg2d/zaldy_2d.c | 8 +- src/mmg3d/API_functions_3d.c | 2 +- src/mmg3d/PRoctree_3d.c | 80 ++-- src/mmg3d/PRoctree_3d_private.h | 2 +- src/mmg3d/analys_3d.c | 16 +- src/mmg3d/anisomovpt_3d.c | 58 +-- src/mmg3d/anisosiz_3d.c | 68 +-- src/mmg3d/bezier_3d.c | 10 +- src/mmg3d/boulep_3d.c | 108 ++--- src/mmg3d/cenrad_3d.c | 4 +- src/mmg3d/chkmsh_3d.c | 20 +- src/mmg3d/colver_3d.c | 30 +- src/mmg3d/delaunay_3d.c | 26 +- src/mmg3d/hash_3d.c | 20 +- src/mmg3d/inlined_functions_3d_private.h | 68 +-- src/mmg3d/inout_3d.c | 8 +- src/mmg3d/intmet_3d.c | 38 +- src/mmg3d/isosiz_3d.c | 42 +- src/mmg3d/libmmg3d.c | 48 +- src/mmg3d/libmmg3d_private.h | 2 +- src/mmg3d/libmmg3d_tools.c | 22 +- src/mmg3d/librnbg_3d.c | 10 +- src/mmg3d/mmg3d.c | 18 +- src/mmg3d/mmg3d1.c | 118 ++--- src/mmg3d/mmg3d1_delone.c | 58 +-- src/mmg3d/mmg3d1_pattern.c | 16 +- src/mmg3d/mmg3d2.c | 44 +- src/mmg3d/mmg3d2s.c | 16 +- src/mmg3d/mmg3d3.c | 24 +- src/mmg3d/movpt_3d.c | 114 ++--- src/mmg3d/optbdry_3d.c | 20 +- src/mmg3d/optlap_3d.c | 4 +- src/mmg3d/opttyp_3d.c | 32 +- src/mmg3d/quality_3d.c | 82 ++-- src/mmg3d/split_3d.c | 128 ++--- src/mmg3d/swap_3d.c | 20 +- src/mmg3d/swapgen_3d.c | 12 +- src/mmg3d/tools_3d.c | 26 +- src/mmg3d/variadic_3d.c | 46 +- src/mmg3d/velextls_3d.c | 20 +- src/mmg3d/zaldy_3d.c | 16 +- src/mmgs/analys_s.c | 18 +- src/mmgs/anisomovpt_s.c | 4 +- src/mmgs/anisosiz_s.c | 30 +- src/mmgs/bezier_s.c | 8 +- src/mmgs/boulep_s.c | 14 +- src/mmgs/chkmsh_s.c | 4 +- src/mmgs/colver_s.c | 14 +- src/mmgs/gentools_s.c | 4 +- src/mmgs/hash_s.c | 8 +- src/mmgs/intmet_s.c | 16 +- src/mmgs/isosiz_s.c | 12 +- src/mmgs/libmmgs.c | 6 +- src/mmgs/libmmgs.h | 412 ++++++++-------- src/mmgs/libmmgs_tools.c | 18 +- src/mmgs/librnbg_s.c | 10 +- src/mmgs/mmgs.c | 12 +- src/mmgs/mmgs1.c | 44 +- src/mmgs/mmgs2.c | 12 +- src/mmgs/movpt_s.c | 12 +- src/mmgs/quality_s.c | 16 +- src/mmgs/split_s.c | 30 +- src/mmgs/swapar_s.c | 8 +- src/mmgs/variadic_s.c | 28 +- src/mmgs/zaldy_s.c | 10 +- 133 files changed, 1904 insertions(+), 1904 deletions(-) diff --git a/libexamples/mmg3d/IsosurfDiscretization_lsAndMetric/main.F90 b/libexamples/mmg3d/IsosurfDiscretization_lsAndMetric/main.F90 index 664ac326f..35f5f02dd 100644 --- a/libexamples/mmg3d/IsosurfDiscretization_lsAndMetric/main.F90 +++ b/libexamples/mmg3d/IsosurfDiscretization_lsAndMetric/main.F90 @@ -72,12 +72,12 @@ PROGRAM main ! args of InitMesh: ! MMG5_ARG_start: we start to give the args of a variadic func ! MMG5_ARG_ppMesh: next arg will be a pointer over a MMG5_pMesh - ! mmgMesh: your MMG5_pMesh (that store your mesh) + ! mmgMesh: your MMG5_pMesh (that stores your mesh) ! MMG5_ARG_ppLs: next arg will be a pointer over a MMG5_pSol storing a level-set - ! mmgLs: pointer toward your MMG5_pSol (that store your level-set) + ! mmgLs: pointer to your MMG5_pSol (that stores your level-set) ! MMG5_ARG_ppMet: next arg will be a pointer over a MMG5_pSol that will ! store the input metric - ! mmgMet: pointer toward your MMG5_pSol (that will store the input metric) + ! mmgMet: pointer to your MMG5_pSol (that will store the input metric) mmgMesh = 0 mmgLs = 0 mmgMet = 0 diff --git a/libexamples/mmg3d/IsosurfDiscretization_lsAndMetric/main.c b/libexamples/mmg3d/IsosurfDiscretization_lsAndMetric/main.c index d8628aeed..ce68f41a9 100644 --- a/libexamples/mmg3d/IsosurfDiscretization_lsAndMetric/main.c +++ b/libexamples/mmg3d/IsosurfDiscretization_lsAndMetric/main.c @@ -88,12 +88,12 @@ int main(int argc,char *argv[]) { /* args of InitMesh: * MMG5_ARG_start: we start to give the args of a variadic func * MMG5_ARG_ppMesh: next arg will be a pointer over a MMG5_pMesh - * &mmgMesh: pointer toward your MMG5_pMesh (that store your mesh) + * &mmgMesh: pointer to your MMG5_pMesh (that stores your mesh) * MMG5_ARG_ppLs: next arg will be a pointer over a MMG5_pSol storing a level-set - * &mmgLs: pointer toward your MMG5_pSol (that store your level-set) + * &mmgLs: pointer to your MMG5_pSol (that stores your level-set) * MMG5_ARG_ppMet: next arg will be a pointer over a MMG5_pSol that will * store the input metric - * &mmgMet: pointer toward your MMG5_pSol (that will store the input metric) */ + * &mmgMet: pointer to your MMG5_pSol (that will store the input metric) */ mmgMesh = NULL; mmgLs = NULL; mmgMet = NULL; diff --git a/libexamples/mmg3d/IsosurfDiscretization_lsAndMetric/main_hsiz.F90 b/libexamples/mmg3d/IsosurfDiscretization_lsAndMetric/main_hsiz.F90 index 1bec73a08..369df75e4 100644 --- a/libexamples/mmg3d/IsosurfDiscretization_lsAndMetric/main_hsiz.F90 +++ b/libexamples/mmg3d/IsosurfDiscretization_lsAndMetric/main_hsiz.F90 @@ -70,9 +70,9 @@ PROGRAM main !! args of InitMesh: !! MMG5_ARG_start: we start to give the args of a variadic func !! MMG5_ARG_ppMesh: next arg will be a pointer over a MMG5_pMesh - !! mmgMesh: your MMG5_pMesh (that store your mesh) + !! mmgMesh: your MMG5_pMesh (that stores your mesh) !! MMG5_ARG_ppLs: next arg will be a pointer over a MMG5_pSol storing a level-set - !! &mmgLs: pointer toward your MMG5_pSol (that store your level-set) + !! &mmgLs: pointer to your MMG5_pSol (that stores your level-set) mmgMesh = 0 mmgLs = 0 diff --git a/libexamples/mmg3d/IsosurfDiscretization_lsAndMetric/main_hsiz.c b/libexamples/mmg3d/IsosurfDiscretization_lsAndMetric/main_hsiz.c index 24f69ad9d..caa423810 100644 --- a/libexamples/mmg3d/IsosurfDiscretization_lsAndMetric/main_hsiz.c +++ b/libexamples/mmg3d/IsosurfDiscretization_lsAndMetric/main_hsiz.c @@ -87,9 +87,9 @@ int main(int argc,char *argv[]) { /* args of InitMesh: * MMG5_ARG_start: we start to give the args of a variadic func * MMG5_ARG_ppMesh: next arg will be a pointer over a MMG5_pMesh - * &mmgMesh: pointer toward your MMG5_pMesh (that store your mesh) + * &mmgMesh: pointer to your MMG5_pMesh (that stores your mesh) * MMG5_ARG_ppLs: next arg will be a pointer over a MMG5_pSol storing a level-set - * &mmgLs: pointer toward your MMG5_pSol (that store your level-set) + * &mmgLs: pointer to your MMG5_pSol (that stores your level-set) */ mmgMesh = NULL; mmgLs = NULL; diff --git a/libexamples/mmg3d/IsosurfDiscretization_lsAndMetric/main_optim.F90 b/libexamples/mmg3d/IsosurfDiscretization_lsAndMetric/main_optim.F90 index f5fb5fe8d..560f9ad74 100644 --- a/libexamples/mmg3d/IsosurfDiscretization_lsAndMetric/main_optim.F90 +++ b/libexamples/mmg3d/IsosurfDiscretization_lsAndMetric/main_optim.F90 @@ -70,9 +70,9 @@ PROGRAM main !! args of InitMesh: !! MMG5_ARG_start: we start to give the args of a variadic func !! MMG5_ARG_ppMesh: next arg will be a pointer over a MMG5_pMesh - !! mmgMesh: your MMG5_pMesh (that store your mesh) + !! mmgMesh: your MMG5_pMesh (that stores your mesh) !! MMG5_ARG_ppLs: next arg will be a pointer over a MMG5_pSol storing a level-set - !! &mmgLs: pointer toward your MMG5_pSol (that store your level-set) + !! &mmgLs: pointer to your MMG5_pSol (that stores your level-set) mmgMesh = 0 mmgLs = 0 diff --git a/libexamples/mmg3d/IsosurfDiscretization_lsAndMetric/main_optim.c b/libexamples/mmg3d/IsosurfDiscretization_lsAndMetric/main_optim.c index 51661497f..6d9f2cb9d 100644 --- a/libexamples/mmg3d/IsosurfDiscretization_lsAndMetric/main_optim.c +++ b/libexamples/mmg3d/IsosurfDiscretization_lsAndMetric/main_optim.c @@ -87,9 +87,9 @@ int main(int argc,char *argv[]) { /* args of InitMesh: * MMG5_ARG_start: we start to give the args of a variadic func * MMG5_ARG_ppMesh: next arg will be a pointer over a MMG5_pMesh - * &mmgMesh: pointer toward your MMG5_pMesh (that store your mesh) + * &mmgMesh: pointer to your MMG5_pMesh (that stores your mesh) * MMG5_ARG_ppLs: next arg will be a pointer over a MMG5_pSol storing a level-set - * &mmgLs: pointer toward your MMG5_pSol (that store your level-set) + * &mmgLs: pointer to your MMG5_pSol (that stores your level-set) */ mmgMesh = NULL; mmgLs = NULL; diff --git a/libexamples/mmg3d/IsosurfDiscretization_lsOnly/main.F90 b/libexamples/mmg3d/IsosurfDiscretization_lsOnly/main.F90 index 7dfd6d727..b920de955 100644 --- a/libexamples/mmg3d/IsosurfDiscretization_lsOnly/main.F90 +++ b/libexamples/mmg3d/IsosurfDiscretization_lsOnly/main.F90 @@ -70,9 +70,9 @@ PROGRAM main !! args of InitMesh: !! MMG5_ARG_start: we start to give the args of a variadic func !! MMG5_ARG_ppMesh: next arg will be a pointer over a MMG5_pMesh - !! mmgMesh: your MMG5_pMesh (that store your mesh) + !! mmgMesh: your MMG5_pMesh (that stores your mesh) !! MMG5_ARG_ppLs: next arg will be a pointer over a MMG5_pSol storing a level-set - !! &mmgLs: pointer toward your MMG5_pSol (that store your level-set) + !! &mmgLs: pointer to your MMG5_pSol (that stores your level-set) mmgMesh = 0 mmgLs = 0 diff --git a/libexamples/mmg3d/IsosurfDiscretization_lsOnly/main.c b/libexamples/mmg3d/IsosurfDiscretization_lsOnly/main.c index bcb0a590c..ac8270ba3 100644 --- a/libexamples/mmg3d/IsosurfDiscretization_lsOnly/main.c +++ b/libexamples/mmg3d/IsosurfDiscretization_lsOnly/main.c @@ -87,9 +87,9 @@ int main(int argc,char *argv[]) { /* args of InitMesh: * MMG5_ARG_start: we start to give the args of a variadic func * MMG5_ARG_ppMesh: next arg will be a pointer over a MMG5_pMesh - * &mmgMesh: pointer toward your MMG5_pMesh (that store your mesh) + * &mmgMesh: pointer to your MMG5_pMesh (that stores your mesh) * MMG5_ARG_ppLs: next arg will be a pointer over a MMG5_pSol storing a level-set - * &mmgLs: pointer toward your MMG5_pSol (that store your level-set) + * &mmgLs: pointer to your MMG5_pSol (that stores your level-set) */ mmgMesh = NULL; mmgLs = NULL; diff --git a/libexamples/mmg3d/IsosurfDiscretization_lsOnly/main_hsiz.F90 b/libexamples/mmg3d/IsosurfDiscretization_lsOnly/main_hsiz.F90 index 5751cff00..6a9bf82e9 100644 --- a/libexamples/mmg3d/IsosurfDiscretization_lsOnly/main_hsiz.F90 +++ b/libexamples/mmg3d/IsosurfDiscretization_lsOnly/main_hsiz.F90 @@ -70,9 +70,9 @@ PROGRAM main !! args of InitMesh: !! MMG5_ARG_start: we start to give the args of a variadic func !! MMG5_ARG_ppMesh: next arg will be a pointer over a MMG5_pMesh - !! mmgMesh: your MMG5_pMesh (that store your mesh) + !! mmgMesh: your MMG5_pMesh (that stores your mesh) !! MMG5_ARG_ppLs: next arg will be a pointer over a MMG5_pSol storing a level-set - !! &mmgLs: pointer toward your MMG5_pSol (that store your level-set) + !! &mmgLs: pointer to your MMG5_pSol (that stores your level-set) mmgMesh = 0 mmgLs = 0 diff --git a/libexamples/mmg3d/IsosurfDiscretization_lsOnly/main_hsiz.c b/libexamples/mmg3d/IsosurfDiscretization_lsOnly/main_hsiz.c index 612e7bba8..241b07708 100644 --- a/libexamples/mmg3d/IsosurfDiscretization_lsOnly/main_hsiz.c +++ b/libexamples/mmg3d/IsosurfDiscretization_lsOnly/main_hsiz.c @@ -87,9 +87,9 @@ int main(int argc,char *argv[]) { /* args of InitMesh: * MMG5_ARG_start: we start to give the args of a variadic func * MMG5_ARG_ppMesh: next arg will be a pointer over a MMG5_pMesh - * &mmgMesh: pointer toward your MMG5_pMesh (that store your mesh) + * &mmgMesh: pointer to your MMG5_pMesh (that stores your mesh) * MMG5_ARG_ppLs: next arg will be a pointer over a MMG5_pSol storing a level-set - * &mmgLs: pointer toward your MMG5_pSol (that store your level-set) + * &mmgLs: pointer to your MMG5_pSol (that stores your level-set) */ mmgMesh = NULL; mmgLs = NULL; diff --git a/libexamples/mmg3d/IsosurfDiscretization_lsOnly/main_optim.F90 b/libexamples/mmg3d/IsosurfDiscretization_lsOnly/main_optim.F90 index e85a010f0..dead53956 100644 --- a/libexamples/mmg3d/IsosurfDiscretization_lsOnly/main_optim.F90 +++ b/libexamples/mmg3d/IsosurfDiscretization_lsOnly/main_optim.F90 @@ -70,9 +70,9 @@ PROGRAM main !! args of InitMesh: !! MMG5_ARG_start: we start to give the args of a variadic func !! MMG5_ARG_ppMesh: next arg will be a pointer over a MMG5_pMesh - !! mmgMesh: your MMG5_pMesh (that store your mesh) + !! mmgMesh: your MMG5_pMesh (that stores your mesh) !! MMG5_ARG_ppLs: next arg will be a pointer over a MMG5_pSol storing a level-set - !! &mmgLs: pointer toward your MMG5_pSol (that store your level-set) + !! &mmgLs: pointer to your MMG5_pSol (that stores your level-set) mmgMesh = 0 mmgLs = 0 diff --git a/libexamples/mmg3d/IsosurfDiscretization_lsOnly/main_optim.c b/libexamples/mmg3d/IsosurfDiscretization_lsOnly/main_optim.c index 3daa06b9b..41f1e7278 100644 --- a/libexamples/mmg3d/IsosurfDiscretization_lsOnly/main_optim.c +++ b/libexamples/mmg3d/IsosurfDiscretization_lsOnly/main_optim.c @@ -87,9 +87,9 @@ int main(int argc,char *argv[]) { /* args of InitMesh: * MMG5_ARG_start: we start to give the args of a variadic func * MMG5_ARG_ppMesh: next arg will be a pointer over a MMG5_pMesh - * &mmgMesh: pointer toward your MMG5_pMesh (that store your mesh) + * &mmgMesh: pointer to your MMG5_pMesh (that stores your mesh) * MMG5_ARG_ppLs: next arg will be a pointer over a MMG5_pSol storing a level-set - * &mmgLs: pointer toward your MMG5_pSol (that store your level-set) + * &mmgLs: pointer to your MMG5_pSol (that stores your level-set) */ mmgMesh = NULL; mmgLs = NULL; diff --git a/libexamples/mmg3d/LagrangianMotion_example0/main.c b/libexamples/mmg3d/LagrangianMotion_example0/main.c index ab598541c..5b0833a8e 100644 --- a/libexamples/mmg3d/LagrangianMotion_example0/main.c +++ b/libexamples/mmg3d/LagrangianMotion_example0/main.c @@ -80,9 +80,9 @@ int main(int argc,char *argv[]) { /* args of InitMesh: * MMG5_ARG_start: we start to give the args of a variadic func * MMG5_ARG_ppMesh: next arg will be a pointer over a MMG5_pMesh - * &mmgMesh: pointer toward your MMG5_pMesh (that store your mesh) + * &mmgMesh: pointer to your MMG5_pMesh (that stores your mesh) * MMG5_ARG_ppMet: next arg will be a pointer over a MMG5_pSol storing a metric - * &mmgSol: pointer toward your MMG5_pSol (that store your metric) */ + * &mmgSol: pointer to your MMG5_pSol (that stores your metric) */ mmgMesh = NULL; mmgSol = NULL; mmgDisp = NULL; diff --git a/libexamples/mmg3d/adaptation_example1/main.c b/libexamples/mmg3d/adaptation_example1/main.c index f9df7a1ff..f109bf9d4 100644 --- a/libexamples/mmg3d/adaptation_example1/main.c +++ b/libexamples/mmg3d/adaptation_example1/main.c @@ -73,9 +73,9 @@ int main(int argc,char *argv[]) { /* args of InitMesh: * MMG5_ARG_start: we start to give the args of a variadic func * MMG5_ARG_ppMesh: next arg will be a pointer over a MMG5_pMesh - * &mmgMesh: pointer toward your MMG5_pMesh (that store your mesh) + * &mmgMesh: pointer to your MMG5_pMesh (that stores your mesh) * MMG5_ARG_ppMet: next arg will be a pointer over a MMG5_pSol storing a metric - * &mmgSol: pointer toward your MMG5_pSol (that store your metric) */ + * &mmgSol: pointer to your MMG5_pSol (that stores your metric) */ mmgMesh = NULL; mmgSol = NULL; diff --git a/libexamples/mmg3d/adaptation_example2/main.c b/libexamples/mmg3d/adaptation_example2/main.c index 38ea47d39..db135c77a 100644 --- a/libexamples/mmg3d/adaptation_example2/main.c +++ b/libexamples/mmg3d/adaptation_example2/main.c @@ -86,9 +86,9 @@ int main(int argc,char *argv[]) { /* args of InitMesh: * MMG5_ARG_start: we start to give the args of a variadic func * MMG5_ARG_ppMesh: next arg will be a pointer over a MMG5_pMesh - * &mmgMesh: pointer toward your MMG5_pMesh (that store your mesh) + * &mmgMesh: pointer to your MMG5_pMesh (that stores your mesh) * MMG5_ARG_ppMet: next arg will be a pointer over a MMG5_pSol storing a metric - * &mmgSol: pointer toward your MMG5_pSol (that store your metric) */ + * &mmgSol: pointer to your MMG5_pSol (that stores your metric) */ mmgMesh = NULL; mmgSol = NULL; diff --git a/libexamples/mmg3d/io_generic_and_get_adja/genericIO.c b/libexamples/mmg3d/io_generic_and_get_adja/genericIO.c index c73832181..d910da2a9 100644 --- a/libexamples/mmg3d/io_generic_and_get_adja/genericIO.c +++ b/libexamples/mmg3d/io_generic_and_get_adja/genericIO.c @@ -94,9 +94,9 @@ int main(int argc,char *argv[]) { /* args of InitMesh: * MMG5_ARG_start: we start to give the args of a variadic func * MMG5_ARG_ppMesh: next arg will be a pointer over a MMG5_pMesh - * &mmgMesh: pointer toward your MMG5_pMesh (that store your mesh) + * &mmgMesh: pointer to your MMG5_pMesh (that stores your mesh) * MMG5_ARG_ppMet: next arg will be a pointer over a MMG5_pSol storing a metric - * &mmgSol: pointer toward your MMG5_pSol (that store your metric) */ + * &mmgSol: pointer to your MMG5_pSol (that stores your metric) */ mmgMesh = NULL; MMG3D_Init_mesh(MMG5_ARG_start, diff --git a/libexamples/mmg3d/io_multisols_example6/main.F90 b/libexamples/mmg3d/io_multisols_example6/main.F90 index 359d387c2..cd8fc998b 100644 --- a/libexamples/mmg3d/io_multisols_example6/main.F90 +++ b/libexamples/mmg3d/io_multisols_example6/main.F90 @@ -51,9 +51,9 @@ PROGRAM main !! args of InitMesh: !! MMG5_ARG_start: we start to give the args of a variadic func !! MMG5_ARG_ppMesh: next arg will be a pointer over a MMG5_pMesh - !! &mmgMesh: pointer toward your MMG5_pMesh (that store your mesh) + !! &mmgMesh: pointer to your MMG5_pMesh (that stores your mesh) !! MMG5_ARG_ppMet: next arg will be a pointer over a MMG5_pSol storing a metric - !! &mmgSol: pointer toward your MMG5_pSol (that store your metric) + !! &mmgSol: pointer to your MMG5_pSol (that stores your metric) mmgMesh = 0 mmgSol = 0 diff --git a/libexamples/mmg3d/io_multisols_example6/main.c b/libexamples/mmg3d/io_multisols_example6/main.c index 9b338579c..c70b58f29 100644 --- a/libexamples/mmg3d/io_multisols_example6/main.c +++ b/libexamples/mmg3d/io_multisols_example6/main.c @@ -67,9 +67,9 @@ int main(int argc,char *argv[]) { /* args of InitMesh: * MMG5_ARG_start: we start to give the args of a variadic func * MMG5_ARG_ppMesh: next arg will be a pointer over a MMG5_pMesh - * &mmgMesh: pointer toward your MMG5_pMesh (that store your mesh) + * &mmgMesh: pointer to your MMG5_pMesh (that stores your mesh) * MMG5_ARG_ppMet: next arg will be a pointer over a MMG5_pSol storing a metric - * &mmgSol: pointer toward your MMG5_pSol (that store your metric) */ + * &mmgSol: pointer to your MMG5_pSol (that stores your metric) */ mmgMesh = NULL; mmgSol = NULL; diff --git a/src/common/API_functions.c b/src/common/API_functions.c index 99aa40b92..06c759fab 100644 --- a/src/common/API_functions.c +++ b/src/common/API_functions.c @@ -43,7 +43,7 @@ #include "mmgcommon_private.h" /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * * Initialization of the input parameters. * @@ -123,8 +123,8 @@ void MMG5_Init_parameters(MMG5_pMesh mesh) { /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure. * * Initialize file names to their default values. * @@ -143,7 +143,7 @@ void MMG5_Init_fileNames(MMG5_pMesh mesh,MMG5_pSol sol } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param meshin input mesh name. * \return 1 if success, 0 if fail * @@ -178,8 +178,8 @@ int MMG5_Set_inputMeshName(MMG5_pMesh mesh, const char* meshin) { } /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure. * \param solin name of the input solution file. * \return 1 if success, 0 if fail * @@ -235,7 +235,7 @@ int MMG5_Set_inputSolName(MMG5_pMesh mesh,MMG5_pSol sol, const char* solin) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param fparamin name of the input solution file. * \return 1 if success, 0 if fail * @@ -263,7 +263,7 @@ int MMG5_Set_inputParamName(MMG5_pMesh mesh, const char* fparamin) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param meshout name of the output mesh file. * \return 1 if success, 0 if fail. * @@ -377,8 +377,8 @@ int MMG5_Set_outputMeshName(MMG5_pMesh mesh, const char* meshout) { /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure. * \param solout name of the output solution file. * \return 0 if failed, 1 otherwise. * @@ -504,8 +504,8 @@ int MMG5_Free_allSols(MMG5_pMesh mesh,MMG5_pSol *sol) { } /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure. * * Structures unallocation before return (common structures between all codes). * @@ -553,8 +553,8 @@ void MMG5_Free_structures(MMG5_pMesh mesh,MMG5_pSol sol){ } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the sol structure. * * File name deallocations before return. * @@ -798,7 +798,7 @@ const char* MMG5_Get_tagName(int tag) } /** - * \param ptr pointer toward the file extension (dot included) + * \param ptr pointer to the file extension (dot included) * \param fmt default file format. * * \return and index associated to the file format detected from the extension. @@ -898,7 +898,7 @@ const char* MMG5_Get_formatName(enum MMG5_Format fmt) /** * \param filename string containing a filename * - * \return pointer toward the filename extension or toward the end of the string + * \return pointer to the filename extension or toward the end of the string * if no extension have been founded * * Get the extension of the filename string. Do not consider '.o' as an extension. @@ -926,7 +926,7 @@ char *MMG5_Get_filenameExt( char *filename ) { /** * \param path string containing a filename and its path * - * \return a pointer toward the path allocated here + * \return a pointer to the path allocated here * * Remove filename from a path and return the path in a newly allocated string. * diff --git a/src/common/analys.c b/src/common/analys.c index 6ad2eebe8..0184a57de 100644 --- a/src/common/analys.c +++ b/src/common/analys.c @@ -37,7 +37,7 @@ /** - * \param mesh pointer toward a MMG5 mesh structure. + * \param mesh pointer to a MMG5 mesh structure. * \return 0 if fail, 1 otherwise. * * Regularization procedure for derivatives, dual Laplacian diff --git a/src/common/anisomovpt.c b/src/common/anisomovpt.c index 6259ad2cb..855d308db 100644 --- a/src/common/anisomovpt.c +++ b/src/common/anisomovpt.c @@ -36,10 +36,10 @@ #include "mmgcommon_private.h" /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param pt pointer toward the tria on which we integrate. - * \param p0 pointer toward the point that we want to move. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param pt pointer to the tria on which we integrate. + * \param p0 pointer to the point that we want to move. * \param pb bezier patch of the triangle. * \param r rotation matrix that sends the normal at point \a p0 to e_z. * \param gv centre of mass that we want to update using the computed element diff --git a/src/common/anisosiz.c b/src/common/anisosiz.c index 1ab713af7..916090550 100644 --- a/src/common/anisosiz.c +++ b/src/common/anisosiz.c @@ -37,9 +37,9 @@ #include "inlined_functions_private.h" /** - * \param mesh pointer toward the mesh structure. - * \param m pointer toward the metric at triangle vertices. - * \param ptt pointer toward the triangle structure. + * \param mesh pointer to the mesh structure. + * \param m pointer to the metric at triangle vertices. + * \param ptt pointer to the triangle structure. * \return The double of the triangle area. * * Compute the double of the area of the surface triangle \a ptt with respect to @@ -112,9 +112,9 @@ double MMG5_surf(MMG5_pMesh mesh,double m[3][6],MMG5_pTria ptt) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param ptt pointer toward the triangle structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param ptt pointer to the triangle structure. * \return The double of the triangle area. * * Compute the double of the area of the surface triangle \a ptt with respect to @@ -157,8 +157,8 @@ double MMG5_surftri_ani(MMG5_pMesh mesh,MMG5_pSol met,MMG5_pTria ptt) { } /** - * \param mesh pointer toward the mesh structure. - * \param ptt pointer toward the triangle structure. + * \param mesh pointer to the mesh structure. + * \param ptt pointer to the triangle structure. * \param ma metric at triangle vertex. * \param mb metric at triangle vertex. * \param mc metric at triangle vertex. @@ -217,8 +217,8 @@ double MMG5_surftri33_ani(MMG5_pMesh mesh,MMG5_pTria ptt, } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param ismet 1 if user provided metric. * * Search for points with unintialized metric and define anisotropic size at @@ -272,8 +272,8 @@ void MMG5_defUninitSize(MMG5_pMesh mesh,MMG5_pSol met,int8_t ismet ) /** * \param k index of the tetrahedra from which we come. - * \param p0 pointer toward the point on which we want to def the metric. - * \param i0 pointer toward the local index of the point in tria. + * \param p0 pointer to the point on which we want to def the metric. + * \param i0 pointer to the local index of the point in tria. * \param b control polygon of triangle. * \param r rotation matrix. * \param c physical coordinates of the curve edge mid-point. @@ -418,12 +418,12 @@ void MMG5_fillDefmetregSys( MMG5_int k, MMG5_pPoint p0, int i0, MMG5_Bezier b, } /** - * \param mesh pointer toward the mesh structure. - * \param r pointer toward the rotation matrix. + * \param mesh pointer to the mesh structure. + * \param r pointer to the rotation matrix. * \param c physical coordinates of the curve edge mid-point. * \param tAA matrix of the system to solve. * \param tAb second member. - * \param m pointer toward the metric. + * \param m pointer to the metric. * \param isqhmax maximum size for edge. * \param isqhmin minimum size for edge. * \param hausd hausdorff value at point. @@ -518,14 +518,14 @@ int MMG5_solveDefmetregSys( MMG5_pMesh mesh, double r[3][3], double c[3], } /** - * \param mesh pointer toward the mesh structure. - * \param p0 pointer toward the point on which we want to define the metric. + * \param mesh pointer to the mesh structure. + * \param p0 pointer to the point on which we want to define the metric. * \param ipref table containing the indices of the edge extremities. - * \param r pointer toward the rotation matrix. + * \param r pointer to the rotation matrix. * \param c physical coordinates of the curve edge mid-point. * \param tAA matrix of the system to solve. * \param tAb second member. - * \param m pointer toward the metric. + * \param m pointer to the metric. * \param isqhmax maximum size for edge. * \param isqhmin minimum size for edge. * \param hausd hausdorff value at point (unused). @@ -712,10 +712,10 @@ int MMG5_solveDefmetrefSys( MMG5_pMesh mesh, MMG5_pPoint p0, MMG5_int ipref[2], } /** - * \param mesh pointer toward the mesh structure. - * \param p0 pointer toward the point at which we define the metric. + * \param mesh pointer to the mesh structure. + * \param p0 pointer to the point at which we define the metric. * \param idp global index of the point at which we define the metric. - * \param iprid pointer toward the two extremities of the ridge. + * \param iprid pointer to the two extremities of the ridge. * \param isqhmin minimum edge size. * \param isqhmax maximum edge size. * \return the computed ridge size in the tangent direction. @@ -815,10 +815,10 @@ double MMG5_ridSizeInTangentDir(MMG5_pMesh mesh, MMG5_pPoint p0, MMG5_int idp, } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param i0 local index in the face of the point on which we want to compute * the metric - * \param bcu pointer toward the barycentric coordinates of vector \a u in the + * \param bcu pointer to the barycentric coordinates of vector \a u in the * looked face. * \param b bezier control polygon for the looked face. * \param isqhmin minimum edge size. @@ -953,9 +953,9 @@ double MMG5_ridSizeInNormalDir(MMG5_pMesh mesh,int i0,double* bcu, } /** - * \param mesh pointer toward the mesh. - * \param met pointer toward the metric structure. - * \param pt pointer toward a triangle. + * \param mesh pointer to the mesh. + * \param met pointer to the metric structure. + * \param pt pointer to a triangle. * \param np1 global index of the first extremity of the edge. * \param np2 global index of the second extremity of the edge. * \return -1 if no gradation is needed, else index of graded point. @@ -1311,7 +1311,7 @@ MMG5_int MMG5_grad2metSurf(MMG5_pMesh mesh, MMG5_pSol met, MMG5_pTria pt, MMG5_i } /** - * \param mesh pointer toward the mesh + * \param mesh pointer to the mesh * \param m first matrix * \param n second matrix * \param dm eigenvalues of m in the coreduction basis (to fill) @@ -1401,7 +1401,7 @@ int MMG5_simred2d(MMG5_pMesh mesh,double *m,double *n,double dm[2], } /** - * \param mesh pointer toward the mesh + * \param mesh pointer to the mesh * \param m first matrix * \param n second matrix * \param dm eigenvalues of m in the coreduction basis (to fill) @@ -1569,7 +1569,7 @@ void MMG5_sort_simred( int8_t dim,double *dm,double *dn,double *vp, } /** - * \param mesh pointer toward the mesh structure + * \param mesh pointer to the mesh structure * \param mex first symmetric test matrix * \param nex second symmetric test matrix * \param dm diagonalization of the first matrix on the reduction basis @@ -1647,7 +1647,7 @@ int MMG5_test_simred2d(MMG5_pMesh mesh,double *mex,double *nex,double *dmex,doub } /** - * \param mesh pointer toward the mesh structure + * \param mesh pointer to the mesh structure * \param mex first symmetric test matrix * \param nex second symmetric test matrix * \param dm diagonalization of the first matrix on the reduction basis @@ -1931,9 +1931,9 @@ int MMG5_updatemetreq_ani(double *n,double dn[2],double vp[2][2]) { } /** - * \param mesh pointer toward the mesh. - * \param met pointer toward the metric structure. - * \param pt pointer toward the processed triangle. + * \param mesh pointer to the mesh. + * \param met pointer to the metric structure. + * \param pt pointer to the processed triangle. * \param npmaster edge extremity that cannot be modified * \param npslave edge extremity to modify to respect the gradation. * @@ -2191,8 +2191,8 @@ int MMG5_grad2metSurfreq(MMG5_pMesh mesh, MMG5_pSol met, MMG5_pTria pt, MMG5_int } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * * \return 1 if success, 0 if fail. * @@ -2246,8 +2246,8 @@ int MMG5_compute_meanMetricAtMarkedPoints_ani ( MMG5_pMesh mesh,MMG5_pSol met ) } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param it number of performed iteration (to fill) * * \return nup, the number of points updated. @@ -2311,8 +2311,8 @@ MMG5_int MMG5_gradsiz_ani(MMG5_pMesh mesh,MMG5_pSol met,int *it) { /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \return 1 * * @@ -2368,8 +2368,8 @@ int MMG5_gradsizreq_ani(MMG5_pMesh mesh,MMG5_pSol met) { } /* Impose the gradation to npslave from npmaster: coming from mmgs, - * MMG5_grad2metreq_ani is a pointer toward MMG5_grad2metSurfreq, - * comming from mmg2d, it is a pointer toward MMG2D_grad2metreq_ani */ + * MMG5_grad2metreq_ani is a pointer to MMG5_grad2metSurfreq, + * comming from mmg2d, it is a pointer to MMG2D_grad2metreq_ani */ ier = MMG5_grad2metreq_ani(mesh,met,pt,npmaster,npslave); if ( ier ) { diff --git a/src/common/apptools.c b/src/common/apptools.c index 3347f836f..682771516 100644 --- a/src/common/apptools.c +++ b/src/common/apptools.c @@ -35,8 +35,8 @@ #include "mmgcommon_private.h" /** - * \param mesh pointer toward the mesh structure (for count of used memory). - * \param node pointer toward a MMG5_iNode (cell for linked list) + * \param mesh pointer to the mesh structure (for count of used memory). + * \param node pointer to a MMG5_iNode (cell for linked list) * \return 1 if we can alloc the node \a node, 0 otherwise. * * Node allocation. @@ -54,8 +54,8 @@ int MMG5_Alloc_inode( MMG5_pMesh mesh, MMG5_iNode **node ) { } /** - * \param mesh pointer toward the mesh structure (for count of used memory). - * \param liLi pointer toward the address of the root of the linked list. + * \param mesh pointer to the mesh structure (for count of used memory). + * \param liLi pointer to the address of the root of the linked list. * \param val value to add to the linked list. * \return 1 if the node is inserted, 0 if the node is not inserted, -1 if fail. * @@ -111,8 +111,8 @@ int MMG5_Add_inode( MMG5_pMesh mesh, MMG5_iNode **liLi, int val ) { } /** - * \param mesh pointer toward the mesh structure (for count of used memory). - * \param liLi pointer toward the root of the linked list. + * \param mesh pointer to the mesh structure (for count of used memory). + * \param liLi pointer to the root of the linked list. * * Free the memory used by the linked list whose root is \a liLi. * @@ -130,8 +130,8 @@ void MMG5_Free_ilinkedList( MMG5_pMesh mesh, MMG5_iNode *liLi ) { } /** - * \param mesh pointer toward the mesh structure. - * \param bdryRefs pointer toward the list of the boundary references. + * \param mesh pointer to the mesh structure. + * \param bdryRefs pointer to the list of the boundary references. * \return npar, the number of local parameters at triangles if success, * 0 otherwise. * @@ -175,9 +175,9 @@ int MMG5_countLocalParamAtTri( MMG5_pMesh mesh,MMG5_iNode **bdryRefs) { } /** - * \param mesh pointer toward the mesh structure. - * \param bdryRefs pointer toward the list of the boundary references. - * \param out pointer toward the file in which to write. + * \param mesh pointer to the mesh structure. + * \param bdryRefs pointer to the list of the boundary references. + * \param out pointer to the file in which to write. * \return 1 if success, 0 otherwise. * * Write the local default values at triangles in the parameter file. diff --git a/src/common/bezier.c b/src/common/bezier.c index bf5f6d009..b3077051a 100644 --- a/src/common/bezier.c +++ b/src/common/bezier.c @@ -36,7 +36,7 @@ #include "mmgcommon_private.h" /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param i0 index of the first extremity of the edge. * \param i1 index of the second extremity of the edge. * \param b0 first computed bezier coefficient. diff --git a/src/common/boulep.c b/src/common/boulep.c index 104d2c3c4..1c51d5d75 100644 --- a/src/common/boulep.c +++ b/src/common/boulep.c @@ -37,12 +37,12 @@ extern MMG5_Info info; /** - * \param mesh pointer toward mesh structure. + * \param mesh pointer to mesh structure. * \param start a triangle to which \a ip belongs. * \param ip local point index - * \param adja pointer toward the adjacency array. - * \param list pointer toward the list of points connected to \a ip. - * \param tlist pointer toward the list of triangles sharing \a ip. + * \param adja pointer to the adjacency array. + * \param list pointer to the list of points connected to \a ip. + * \param tlist pointer to the list of triangles sharing \a ip. * * \return -ilist if buffer overflow, ilist otherwise. * @@ -106,11 +106,11 @@ int MMG5_boulep(MMG5_pMesh mesh,MMG5_int start,int ip,MMG5_int *adja, MMG5_int * } /** - * \param mesh pointer toward the mesh structure. - * \param adjt pointer toward the table of triangle adjacency. + * \param mesh pointer to the mesh structure. + * \param adjt pointer to the table of triangle adjacency. * \param start index of triangle where we start to work. * \param ip local index of vertex where the normal is computed. - * \param nn pointer toward the computed tangent. + * \param nn pointer to the computed tangent. * \return 0 if fail, 1 otherwise. * * Compute average normal of triangles sharing P without crossing ridge. @@ -186,11 +186,11 @@ int MMG5_boulen(MMG5_pMesh mesh,MMG5_int *adjt,MMG5_int start,int ip,double *nn) } /** - * \param mesh pointer toward the mesh structure. - * \param adjt pointer toward the table of triangle adjacency. + * \param mesh pointer to the mesh structure. + * \param adjt pointer to the table of triangle adjacency. * \param start index of triangle where we start to work. * \param ip index of vertex where the tangent is computed. - * \param tt pointer toward the computed tangent. + * \param tt pointer to the computed tangent. * \return 0 if fail, 1 otherwise. * * Compute the tangent to the curve at point \a ip. @@ -269,14 +269,14 @@ int MMG5_boulec(MMG5_pMesh mesh,MMG5_int *adjt,MMG5_int start,int ip,double *tt) } /** - * \param mesh pointer toward the mesh structure. - * \param adjt pointer toward the table of triangle adjacency. + * \param mesh pointer to the mesh structure. + * \param adjt pointer to the table of triangle adjacency. * \param start index of triangle where we start to work. * \param ip index of vertex on which we work. - * \param list pointer toward the computed list of GEO vertices incident to \a ip. - * \param listref pointer toward the corresponding edge references - * \param ng pointer toward the number of ridges. - * \param nr pointer toward the number of reference edges. + * \param list pointer to the computed list of GEO vertices incident to \a ip. + * \param listref pointer to the corresponding edge references + * \param ng pointer to the number of ridges. + * \param nr pointer to the number of reference edges. * \param lmax maxmum size for the ball of the point \a ip. * \return The number of edges incident to the vertex \a ip. * @@ -348,10 +348,10 @@ int MMG5_bouler(MMG5_pMesh mesh,MMG5_int *adjt,MMG5_int start,int ip, } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param start index of triangle to start. * \param ip index of point for wich we compute the ball. - * \param list pointer toward the computed ball of \a ip. + * \param list pointer to the computed ball of \a ip. * \param s 1 if called from mmgs, 0 if called from mmg2d. * \param opn 0 for a closed ball, 1 for an open ball. * \return the size of the computed ball or 0 if fail. diff --git a/src/common/chrono.c b/src/common/chrono.c index 21a049bdf..9fe02e321 100644 --- a/src/common/chrono.c +++ b/src/common/chrono.c @@ -44,7 +44,7 @@ * \brief Function to measure time. * \param cmode macro that allow to reset (RESET), start (ON) or stop (OFF) * the chrono. - * \param *ptt pointer toward mytime object that store the chronograph informations. + * \param *ptt pointer to mytime object that store the chronograph informations. */ void chrono(int cmode,mytime *ptt) { @@ -144,7 +144,7 @@ void tminit(mytime *t,int maxtim) { * \fn void printim(double elps,char *stim) * \brief Print real time. * \param elps elapsed time in seconds. - * \param stim pointer toward string containg the elapsed time at .h.m.s format. + * \param stim pointer to string containg the elapsed time at .h.m.s format. */ void printim(double elps,char *stim) { sprintf(stim,""); @@ -155,7 +155,7 @@ void printim(double elps,char *stim) { * \fn void printim(double elps,char *stim) * \brief Print real time. * \param elps elapsed time in seconds. - * \param stim pointer toward string containg the elapsed time at .h.m.s format. + * \param stim pointer to string containg the elapsed time at .h.m.s format. */ void printim(double elps,char *stim) { int hh,mm,ss; diff --git a/src/common/eigenv.c b/src/common/eigenv.c index 68ea53f50..9e3f8359b 100644 --- a/src/common/eigenv.c +++ b/src/common/eigenv.c @@ -291,7 +291,7 @@ newton : } /** - * \param mat pointer toward a 3x3 matrix. + * \param mat pointer to a 3x3 matrix. * \param lambda eigenvalues. * \param v eigenvectors. * \param w1 temporary array to perform the matrix cross product. @@ -373,7 +373,7 @@ int MMG5_check_accuracy(double mat[6],double lambda[3], double v[3][3], /** * \brief Find eigenvalues and vectors of a 3x3 matrix. * \param symmat 0 if matrix is not symetric, 1 otherwise. - * \param mat pointer toward the matrix. + * \param mat pointer to the matrix. * \param lambda eigenvalues. * \param v eigenvectors. * @@ -768,7 +768,7 @@ int MMG5_eigenv3d(int symmat,double *mat,double lambda[3],double v[3][3]) { /** * \brief Find eigenvalues and vectors of a 2x2 matrix. * \param symmat 0 if matrix is not symetric, 1 otherwise. - * \param mat pointer toward the matrix. + * \param mat pointer to the matrix. * \param lambda eigenvalues. * \param v eigenvectors. * @@ -848,8 +848,8 @@ int MMG5_eigenv2d(int symmat,double *mat,double lambda[2],double vp[2][2]) { /** * \brief Find eigenvalues and vectors of a 2x2 matrix. - * \param mm pointer toward the matrix. - * \param lambda pointer toward the output eigenvalues. + * \param mm pointer to the matrix. + * \param lambda pointer to the output eigenvalues. * \param vp eigenvectors. * \return 1. * diff --git a/src/common/hash.c b/src/common/hash.c index 99d4af530..811e2b85e 100644 --- a/src/common/hash.c +++ b/src/common/hash.c @@ -35,9 +35,9 @@ #include "mmgcommon_private.h" /** - * \param mesh pointer toward the mesh structure. - * \param adjt pointer toward the adjacency table of the surfacic mesh. - * \param hash pointer toward the edge hash table. + * \param mesh pointer to the mesh structure. + * \param adjt pointer to the adjacency table of the surfacic mesh. + * \param hash pointer to the edge hash table. * \param chkISO flag to say if we check ISO references * (so if we come from mmg3d). * \return 1 if success, 0 otherwise. @@ -271,8 +271,8 @@ int MMG5_mmgHashTria(MMG5_pMesh mesh, MMG5_int *adjt, MMG5_Hash *hash, int chkIS } /** - * \param mesh pointer toward the mesh. - * \param hash pointer toward the hash table to fill. + * \param mesh pointer to the mesh. + * \param hash pointer to the hash table to fill. * \param ia first vertex of face to hash. * \param ib second vertex of face to hash. * \param ic third vertex of face to hash. @@ -332,8 +332,8 @@ MMG5_int MMG5_hashFace(MMG5_pMesh mesh,MMG5_Hash *hash,MMG5_int ia,MMG5_int ib,M } /** - * \param mesh pointer toward the mesh structure. - * \param hash pointer toward the hash table of edges. + * \param mesh pointer to the mesh structure. + * \param hash pointer to the hash table of edges. * \param a index of the first extremity of the edge. * \param b index of the second extremity of the edge. * \param k index of point along the edge. @@ -389,8 +389,8 @@ int MMG5_hashEdge(MMG5_pMesh mesh,MMG5_Hash *hash, MMG5_int a,MMG5_int b,MMG5_in /** - * \param mesh pointer toward the mesh structure. - * \param hash pointer toward the hash table of edges. + * \param mesh pointer to the mesh structure. + * \param hash pointer to the hash table of edges. * \param a index of the first extremity of the edge. * \param b index of the second extremity of the edge. * \param k new index of point along the edge. @@ -427,8 +427,8 @@ int MMG5_hashUpdate(MMG5_Hash *hash, MMG5_int a,MMG5_int b,MMG5_int k) { } /** - * \param mesh pointer toward the mesh structure. - * \param hash pointer toward the hash table of edges. + * \param mesh pointer to the mesh structure. + * \param hash pointer to the hash table of edges. * \param a index of the first extremity of the edge. * \param b index of the second extremity of the edge. * \param tag edge tag @@ -488,7 +488,7 @@ int MMG5_hashEdgeTag(MMG5_pMesh mesh,MMG5_Hash *hash, MMG5_int a,MMG5_int b,int1 } /** - * \param hash pointer toward the hash table of edges. + * \param hash pointer to the hash table of edges. * \param a index of the first extremity of the edge. * \param b index of the second extremity of the edge. * \return the index of point stored along \f$[a;b]\f$. @@ -520,8 +520,8 @@ MMG5_int MMG5_hashGet(MMG5_Hash *hash,MMG5_int a,MMG5_int b) { } /** - * \param mesh pointer toward the mesh structure. - * \param hash pointer toward the hash table of edges. + * \param mesh pointer to the mesh structure. + * \param hash pointer to the hash table of edges. * \param hsiz initial size of hash table. * \param hmax maximal size of hash table. * \return 1 if success, 0 if fail. diff --git a/src/common/inlined_functions_private.h b/src/common/inlined_functions_private.h index dfc4ab7d1..451c6a4ee 100644 --- a/src/common/inlined_functions_private.h +++ b/src/common/inlined_functions_private.h @@ -37,7 +37,7 @@ #define _INLINED_FUNC_H /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param np0 index of edge's extremity. * \param np1 index of edge's extremity. * \param m0 metric at point np0. @@ -181,8 +181,8 @@ double MMG5_lenEdg(MMG5_pMesh mesh,MMG5_int np0,MMG5_int np1, } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the sol structure. * \param np0 index of edge's extremity. * \param np1 index of edge's extremity. * \param isedg 1 if the edge is a ridge, 0 otherwise. @@ -250,8 +250,8 @@ double MMG5_lenSurfEdg_ani(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int np0,MMG5_int n /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the sol structure. * \param np0 index of edge's extremity. * \param np1 index of edge's extremity. * \param isedg 1 if the edge is a ridge, 0 otherwise. @@ -274,8 +274,8 @@ double MMG5_lenSurfEdg33_ani(MMG5_pMesh mesh,MMG5_pSol met, } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the sol structure. * \param ip1 index of edge's extremity. * \param ip2 index of edge's extremity. * \param isedg 1 if the edge is a ridge, 0 otherwise (dummy arg for diff --git a/src/common/inout.c b/src/common/inout.c index 15525af78..24722db35 100644 --- a/src/common/inout.c +++ b/src/common/inout.c @@ -110,7 +110,7 @@ double MMG5_swapd(double sbin) } /** - * \param inm pointer toward file unit + * \param inm pointer to file unit * \param nelts number of elements * \param iswap 1 if we need to swap bites for little/big endian conversion * \param np number of points @@ -260,12 +260,12 @@ int MMG5_countBinaryElts(FILE **inm, const int nelts,const int iswp, } /** - * \param mesh pointer toward the mesh - * \param filename pointer toward the name of file - * \param inm pointer toward the file pointer - * \param posNodes pointer toward the position of nodes data in file - * \param posElts pointer toward the position of elts data in file - * \param posNodeData pointer toward the list of the positions of data in file + * \param mesh pointer to the mesh + * \param filename pointer to the name of file + * \param inm pointer to the file pointer + * \param posNodes pointer to the position of nodes data in file + * \param posElts pointer to the position of elts data in file + * \param posNodeData pointer to the list of the positions of data in file * \param bin 1 if binary format * \param nelts number of elements in file * \param nsol number of data in file @@ -514,8 +514,8 @@ int MMG5_loadMshMesh_part1(MMG5_pMesh mesh,const char *filename, } /** - * \param mesh pointer toward an Mmg mesh - * \param nref pointer toward the number of negative refs (replaced by abolute values). + * \param mesh pointer to an Mmg mesh + * \param nref pointer to the number of negative refs (replaced by abolute values). * * \return 1 if success, 0 otherwise * @@ -643,9 +643,9 @@ int MMG5_check_readedMesh ( MMG5_pMesh mesh, MMG5_int nref ) { } /** - * \param mesh pointer toward the mesh - * \param sol pointer toward the solutions array - * \param inm pointer toward the file pointer + * \param mesh pointer to the mesh + * \param sol pointer to the solutions array + * \param inm pointer to the file pointer * \param posNodes position of nodes data in file * \param posElts position of elts data in file * \param posNodeData position of solution data in file @@ -1511,8 +1511,8 @@ int MMG5_loadMshMesh_part2(MMG5_pMesh mesh,MMG5_pSol *sol,FILE **inm, } /** - * \param mesh pointer toward the mesh structure - * \param sol pointer toward the sol structure. + * \param mesh pointer to the mesh structure + * \param sol pointer to the sol structure. * \param index of point in which we want to build the metric * \param dbuf builded metric * @@ -1568,8 +1568,8 @@ void MMG5_build3DMetric(MMG5_pMesh mesh,MMG5_pSol sol,MMG5_int ip, } /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward an array of solutions. + * \param mesh pointer to the mesh structure. + * \param sol pointer to an array of solutions. * \param filename name of file. * \param metricData 1 if the data saved is a metric (if only 1 data) * \return 0 if failed, 1 otherwise. @@ -2055,7 +2055,7 @@ int MMG5_saveMshMesh(MMG5_pMesh mesh,MMG5_pSol *sol,const char *filename, /** * \param filename name of file. * \param meshDim mesh dimenson. - * \param inm allocatable pointer toward the FILE structure + * \param inm allocatable pointer to the FILE structure * \param ver file version (1=simple precision, 2=double) * \param bin 1 if the file is a binary * \param iswp 1 or 0 depending on the endianness (binary only) @@ -2063,7 +2063,7 @@ int MMG5_saveMshMesh(MMG5_pMesh mesh,MMG5_pSol *sol,const char *filename, * \param dim solution dimension * \param nsols number of solutions of different types in the file * \param type type of solutions - * \param posnp pointer toward the position of the point list in the file + * \param posnp pointer to the position of the point list in the file * \param imprim verbosity * * \return -1 data invalid or we fail, 0 no file, 1 ok. @@ -2206,8 +2206,8 @@ int MMG5_loadSolHeader( const char *filename,int meshDim,FILE **inm,int *ver, } /** - * \param sol pointer toward an allocatable sol structure. - * \param inm pointer toward the solution file + * \param sol pointer to an allocatable sol structure. + * \param inm pointer to the solution file * \param bin 1 if binary file * \param iswp Endianess * \param index of the readed solution @@ -2255,8 +2255,8 @@ int MMG5_readFloatSol3D(MMG5_pSol sol,FILE *inm,int bin,int iswp,int pos) { } /** - * \param sol pointer toward an allocatable sol structure. - * \param inm pointer toward the solution file + * \param sol pointer to an allocatable sol structure. + * \param inm pointer to the solution file * \param bin 1 if binary file * \param iswp Endianess * \param index of the readed solution @@ -2305,9 +2305,9 @@ int MMG5_readDoubleSol3D(MMG5_pSol sol,FILE *inm,int bin,int iswp,MMG5_int pos) } /** - * \param mesh pointer toward the mesh structure - * \param sol pointer toward an allocatable sol structure. - * \param inm pointer toward the solution file + * \param mesh pointer to the mesh structure + * \param sol pointer to an allocatable sol structure. + * \param inm pointer to the solution file * \param bin 1 if binary file * \param pos of the writted solution * \param metricData 1 if the data saved is a metric (if only 1 data) @@ -2365,9 +2365,9 @@ void MMG5_writeDoubleSol3D(MMG5_pMesh mesh,MMG5_pSol sol,FILE *inm,int bin, } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param filename name of file. - * \param inm allocatable pointer toward the FILE structure. + * \param inm allocatable pointer to the FILE structure. * \param ver file version (1=simple precision, 2=double). * \param bin 1 if the file is a binary. * \param bpos cumulative field position for binary Medit format. @@ -2507,8 +2507,8 @@ int MMG5_saveSolHeader( MMG5_pMesh mesh,const char *filename, } /** - * \param mesh pointer toward the mesh structure. - * \param inm pointer toward the opened file unit. + * \param mesh pointer to the mesh structure. + * \param inm pointer to the opened file unit. * \param ver file version (1=simple precision, 2=double). * \param bin 1 if the file is a binary. * \param bpos cumulative field position for binary Medit format. @@ -2576,8 +2576,8 @@ int MMG5_saveSolAtTrianglesHeader( MMG5_pMesh mesh, } /** - * \param mesh pointer toward the mesh structure. - * \param inm pointer toward the opened file unit. + * \param mesh pointer to the mesh structure. + * \param inm pointer to the opened file unit. * \param ver file version (1=simple precision, 2=double). * \param bin 1 if the file is a binary. * \param bpos cumulative field position for binary Medit format. @@ -2645,7 +2645,7 @@ int MMG5_saveSolAtTetrahedraHeader( MMG5_pMesh mesh, } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param type type of the metric * \param entities entities on which the metric applies (should be MMG5_Vertex) * \param inm metric file @@ -2696,8 +2696,8 @@ int MMG5_chkMetricType(MMG5_pMesh mesh,int *type, int *entities, FILE *inm) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * * print metric statistics * @@ -2714,8 +2714,8 @@ void MMG5_printMetStats(MMG5_pMesh mesh,MMG5_pSol met) { } /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solutions array. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solutions array. * * print solutions statistics * diff --git a/src/common/intmet.c b/src/common/intmet.c index 153b93545..d4ce67144 100644 --- a/src/common/intmet.c +++ b/src/common/intmet.c @@ -146,8 +146,8 @@ int MMG5_mmgIntmet33_ani(double *m,double *n,double *mr,double s) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param ip1 global index of ridge extremity. * \param ip2 global index of ridge extremity. * \param s interpolation parameter (between 0 and 1). @@ -490,9 +490,9 @@ int MMG5_interp_iso(double *ma,double *mb,double *mp,double t) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param pt pointer toward the triangle structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param pt pointer to the triangle structure. * \param i edge of the triangle pt * \param s interpolated parameter (comprise between 0 and 1) * \param mr computed interpolated metric diff --git a/src/common/isosiz.c b/src/common/isosiz.c index 22af4dbd4..130227f6f 100644 --- a/src/common/isosiz.c +++ b/src/common/isosiz.c @@ -30,9 +30,9 @@ #include "mmgcommon_private.h" /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the meric structure. - * \param ptt pointer toward the triangle structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the meric structure. + * \param ptt pointer to the triangle structure. * \return The computed area. * * Compute the area of the surface triangle \a ptt with respect to @@ -64,8 +64,8 @@ double MMG5_surftri_iso(MMG5_pMesh mesh,MMG5_pSol met,MMG5_pTria ptt) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param funcname name of the calling function * * \return 1 if success, 0 if fail. @@ -88,7 +88,7 @@ int MMG5_defsiz_startingMessage (MMG5_pMesh mesh,MMG5_pSol met,const char * func } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * * Print gradation values (depending on the verbosity). * @@ -114,8 +114,8 @@ void MMG5_gradation_info ( MMG5_pMesh mesh ) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param ip0 index of the first edge extremity * \param ip1 index of the second edge extremity * @@ -153,8 +153,8 @@ int MMG5_sum_reqEdgeLengthsAtPoint ( MMG5_pMesh mesh,MMG5_pSol met,MMG5_int ip0, } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * * \return 1 if success, 0 if fail. * @@ -191,8 +191,8 @@ int MMG5_compute_meanMetricAtMarkedPoints_iso ( MMG5_pMesh mesh,MMG5_pSol met ) } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param ismet 1 if user provided metric * * \return 1 if success, 0 if fail. @@ -234,7 +234,7 @@ int MMG5_reset_metricAtReqEdges_surf ( MMG5_pMesh mesh,MMG5_pSol met,int8_t isme } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * * Set the s field of the points that belongs to a required edge to 1, set it to * 0 otherwise. @@ -266,8 +266,8 @@ void MMG5_mark_pointsOnReqEdge_fromTria ( MMG5_pMesh mesh ) { } /** - * \param mesh pointer toward the mesh - * \param met pointer toward the metric + * \param mesh pointer to the mesh + * \param met pointer to the metric * * \return 0 if fail, 1 otherwise * @@ -360,8 +360,8 @@ int MMG5_gradsiz_iso(MMG5_pMesh mesh,MMG5_pSol met) { } /** - * \param mesh pointer toward the mesh - * \param met pointer toward the metric + * \param mesh pointer to the mesh + * \param met pointer to the metric * * \return the number of updated metrics. * diff --git a/src/common/libmmgcommon_private.h b/src/common/libmmgcommon_private.h index 8102451e9..ba3d0bf7a 100644 --- a/src/common/libmmgcommon_private.h +++ b/src/common/libmmgcommon_private.h @@ -51,8 +51,8 @@ extern "C" { /*----------------------------- functions header -----------------------------*/ /* Initialization functions */ /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure. * * Initialize file names to their default values. * @@ -65,7 +65,7 @@ extern "C" { LIBMMG_CORE_EXPORT void MMG5_Init_fileNames(MMG5_pMesh mesh, MMG5_pSol sol); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * * Initialization of the input parameters (stored in the Info structure). * @@ -79,7 +79,7 @@ LIBMMG_CORE_EXPORT void (MMG5_Init_parameters)(MMG5_pMesh mesh); /* init file names */ /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param meshin input mesh name. * \return 1. * @@ -96,7 +96,7 @@ LIBMMG_CORE_EXPORT void (MMG5_Init_parameters)(MMG5_pMesh mesh); */ LIBMMG_CORE_EXPORT int MMG5_Set_inputMeshName(MMG5_pMesh mesh, const char* meshin); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param meshout name of the output mesh file. * \return 1. * @@ -113,8 +113,8 @@ LIBMMG_CORE_EXPORT int MMG5_Set_inputMeshName(MMG5_pMesh mesh, const char* mesh */ LIBMMG_CORE_EXPORT int MMG5_Set_outputMeshName(MMG5_pMesh mesh, const char* meshout); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure. * \param solin name of the input solution file. * \return 1. * @@ -131,7 +131,7 @@ LIBMMG_CORE_EXPORT int MMG5_Set_outputMeshName(MMG5_pMesh mesh, const char* mes */ LIBMMG_CORE_EXPORT int MMG5_Set_inputSolName(MMG5_pMesh mesh,MMG5_pSol sol, const char* solin); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param fparamin name of the input parameter file. * \return 0 if failed, 1 otherwise. * @@ -148,8 +148,8 @@ LIBMMG_CORE_EXPORT int MMG5_Set_inputSolName(MMG5_pMesh mesh,MMG5_pSol sol, con */ LIBMMG_CORE_EXPORT int MMG5_Set_inputParamName(MMG5_pMesh mesh, const char* fparamin); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure. * \param solout name of the output solution file. * \return 0 if failed, 1 otherwise. * @@ -166,9 +166,9 @@ LIBMMG_CORE_EXPORT int MMG5_Set_inputSolName(MMG5_pMesh mesh,MMG5_pSol sol, con */ LIBMMG_CORE_EXPORT int MMG5_Set_outputSolName(MMG5_pMesh mesh,MMG5_pSol sol, const char* solout); /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param ls pointer toward a solution structure (level-set or displacement). + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param ls pointer to a solution structure (level-set or displacement). * * \return 1 if success, 0 if fail (computed bounding box too small * or one af the anisotropic input metric is not valid). @@ -187,9 +187,9 @@ LIBMMG_CORE_EXPORT int MMG5_Set_inputSolName(MMG5_pMesh mesh,MMG5_pSol sol, con LIBMMG_CORE_EXPORT int MMG5_scaleMesh(MMG5_pMesh mesh,MMG5_pSol met,MMG5_pSol ls); /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward a metric. - * \param sol pointer toward a solution structure (level-set or displacement). + * \param mesh pointer to the mesh structure. + * \param met pointer to a metric. + * \param sol pointer to a solution structure (level-set or displacement). * * \return 1. * @@ -206,8 +206,8 @@ LIBMMG_CORE_EXPORT int MMG5_Set_inputSolName(MMG5_pMesh mesh,MMG5_pSol sol, con LIBMMG_CORE_EXPORT int MMG5_unscaleMesh(MMG5_pMesh mesh,MMG5_pSol met,MMG5_pSol ls); /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the sol structure. * \param hsiz wanted edge size * * fill the metric field with the size \a hsiz @@ -218,8 +218,8 @@ LIBMMG_CORE_EXPORT int MMG5_Set_inputSolName(MMG5_pMesh mesh,MMG5_pSol sol, con LIBMMG_CORE_EXPORT void MMG5_Set_constantSize(MMG5_pMesh mesh,MMG5_pSol met,double hsiz); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure. * \param ref input tetra reference. * \param split MMG5_MMAT_NoSplit if the entity must not be splitted, MMG5_MMAT_Split otherwise * \param rin internal reference after ls discretization @@ -234,8 +234,8 @@ LIBMMG_CORE_EXPORT int MMG5_Set_multiMat(MMG5_pMesh mesh, MMG5_pSol sol,MMG5_in /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure. * \param br new level-set base reference. * \return 0 if failed, 1 otherwise. * @@ -251,8 +251,8 @@ LIBMMG_CORE_EXPORT int MMG5_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol, LIBMMG_CORE_EXPORT void MMG5_Free_structures(MMG5_pMesh mesh,MMG5_pSol sol); /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the sol structure. * * File name deallocations before return. * @@ -265,7 +265,7 @@ LIBMMG_CORE_EXPORT void MMG5_Free_structures(MMG5_pMesh mesh,MMG5_pSol sol); LIBMMG_CORE_EXPORT void MMG5_mmgFree_names(MMG5_pMesh mesh, MMG5_pSol met); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param sethmin 1 if hmin is already setted (>0.) * \param sethmax 1 if hmax is already setted (>0.) * @@ -279,8 +279,8 @@ LIBMMG_CORE_EXPORT void MMG5_mmgFree_names(MMG5_pMesh mesh, MMG5_pSol met); LIBMMG_CORE_EXPORT extern int MMG5_Set_defaultTruncatureSizes(MMG5_pMesh mesh,int8_t sethmin,int8_t sethmax); /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric. * \param hsiz computed constant size to impose. * * \return 1 if success, 0 if fail @@ -303,8 +303,8 @@ LIBMMG_CORE_EXPORT int MMG5_Compute_constantSize(MMG5_pMesh mesh,MMG5_pSol met,d const char* MMG5_Get_tagName(int tag); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward an array of solution structure (that stores solution fields). + * \param mesh pointer to the mesh structure. + * \param sol pointer to an array of solution structure (that stores solution fields). * \return 1 * * Deallocation of an array of solution fields @@ -313,7 +313,7 @@ const char* MMG5_Get_tagName(int tag); LIBMMG_CORE_EXPORT int MMG5_Free_allSols(MMG5_pMesh mesh,MMG5_pSol *sol); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param filename name of file. * * \return 1 if success, 0 if fail. @@ -323,7 +323,7 @@ LIBMMG_CORE_EXPORT int MMG5_Free_allSols(MMG5_pMesh mesh,MMG5_pSol *sol); LIBMMG_CORE_EXPORT int MMG5_saveNode(MMG5_pMesh mesh,const char *filename); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param filename name of file. * \param ext file extension (.poly or .edge) * @@ -337,7 +337,7 @@ LIBMMG_CORE_EXPORT int MMG5_saveEdge(MMG5_pMesh mesh,const char *filename,const /** * \param path string containing a filename and its path * - * \return a pointer toward the allocated string that contains the file basename. + * \return a pointer to the allocated string that contains the file basename. * * Extract basename from a path (allocate a string to store it). * @@ -345,7 +345,7 @@ LIBMMG_CORE_EXPORT int MMG5_saveEdge(MMG5_pMesh mesh,const char *filename,const LIBMMG_CORE_EXPORT char *MMG5_Get_basename(char *path); /** - * \param ptr pointer toward the file extension (dot included) + * \param ptr pointer to the file extension (dot included) * \param fmt default file format. * * \return and index associated to the file format detected from the extension. @@ -360,7 +360,7 @@ LIBMMG_CORE_EXPORT int MMG5_Get_format( char *ptr, int fmt ); /** * \param filename string containing a filename * - * \return pointer toward the filename extension or toward the end of the string + * \return pointer to the filename extension or toward the end of the string * if no extension have been founded * * Get the extension of the filename string. Do not consider '.o' as an extension. @@ -371,7 +371,7 @@ LIBMMG_CORE_EXPORT char *MMG5_Get_filenameExt( char *filename ); /** * \param path string containing a filename and its path * - * \return a pointer toward the path allocated here + * \return a pointer to the path allocated here * * Remove filename from a path and return the path in a newly allocated string. * @@ -421,7 +421,7 @@ LIBMMG_CORE_EXPORT const char* MMG5_Get_typeName(enum MMG5_type typ); /** - * \param mesh pointer toward mesh + * \param mesh pointer to mesh * * \return 1 if successful, 0 otherwise * diff --git a/src/common/librnbg.c b/src/common/librnbg.c index fdbece76c..65ed81646 100644 --- a/src/common/librnbg.c +++ b/src/common/librnbg.c @@ -39,11 +39,11 @@ #include "librnbg_private.h" /** - * \param graf pointer toward the input graph structure. + * \param graf pointer to the input graph structure. * \param vertNbr the number of vertices. * \param boxVertNbr the number of vertices of each box. * \param permVrtTab the new numbering. - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \return 0 if ok, 1 otherwise. * * Internal function that computes a new numbering of graph vertices using a @@ -142,11 +142,11 @@ int MMG5_kPartBoxCompute(SCOTCH_Graph *graf, MMG5_int vertNbr, MMG5_int boxVertN } /** - * \param mesh pointer toward the mesh - * \param points pointer toward a table containing the point structures. - * \param sols pointer toward a table containing the solution structures. - * \param fields pointer toward an array of solution fields to permute. - * \param *perm pointer toward the permutation table (to perform in place + * \param mesh pointer to the mesh + * \param points pointer to a table containing the point structures. + * \param sols pointer to a table containing the solution structures. + * \param fields pointer to an array of solution fields to permute. + * \param *perm pointer to the permutation table (to perform in place * permutations). * \param ind1 index of the first tetra to swap. * \param ind2 index of the second tetra to swap. @@ -216,9 +216,9 @@ void MMG5_swapNod(MMG5_pMesh mesh,MMG5_pPoint points, double* sols, #endif /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the solution structure. - * \param fields pointer toward an array of solution fields (non mandatory) + * \param mesh pointer to the mesh structure. + * \param met pointer to the solution structure. + * \param fields pointer to an array of solution fields (non mandatory) * \param permNodGlob store the global permutation of nodes (if provided). * * \return 0 if \a MMG5_renumbering fail (non conformal mesh), 1 otherwise diff --git a/src/common/libtools.c b/src/common/libtools.c index 8bc58155a..77603d066 100644 --- a/src/common/libtools.c +++ b/src/common/libtools.c @@ -35,7 +35,7 @@ #include "mmgcommon_private.h" /** - * \param mesh pointer toward the mesh + * \param mesh pointer to the mesh * \param dim string dontaining the dimension (3D,2D or S) * * Print MMG release and date @@ -61,7 +61,7 @@ void MMG5_version(MMG5_pMesh mesh,char *dim) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \return 0 if fail, 1 if success. * * Print the default parameters values. @@ -204,7 +204,7 @@ int MMG5_Set_lsBaseReference(MMG5_pMesh mesh,MMG5_pSol sol,MMG5_int br) { /** - * \param *prog pointer toward the program name. + * \param *prog pointer to the program name. * * Print help for common options of the 3 codes (first section). * @@ -311,8 +311,8 @@ void MMG5_advancedUsage(void) { } /** - * \param mesh pointer toward mesh - * \param pa pointer toward edge + * \param mesh pointer to mesh + * \param pa pointer to edge * * Clean tags linked to iso surface discretization (MG_CRN, MG_ISO) along edge. * @@ -335,8 +335,8 @@ void MMG5_Clean_isoTags(MMG5_pMesh mesh,MMG5_pEdge pa) { } /** - * \param mesh pointer toward mesh - * \param pa pointer toward mesh edge + * \param mesh pointer to mesh + * \param pa pointer to mesh edge * * \return 1 if edge should be removed when cleaning old iso surface, 0 otherwise. * @@ -360,7 +360,7 @@ int8_t MMG5_should_edge_be_removed(MMG5_pMesh mesh,MMG5_pEdge pa){ } /** - * \param mesh pointer toward mesh + * \param mesh pointer to mesh * \param return 1 if successful, 0 if fail * * Clean edges belonging to isosurf, except for ridges. diff --git a/src/common/mettools.c b/src/common/mettools.c index 63aa91325..55e5ecfd1 100644 --- a/src/common/mettools.c +++ b/src/common/mettools.c @@ -36,7 +36,7 @@ #include "inlined_functions_private.h" /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param dim matrix size. * \param m matrix array. * \param lambda eigenvalues array. @@ -82,7 +82,7 @@ void MMG5_eigenvmat_buildsym(MMG5_pMesh mesh,int8_t dim,double m[], } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param m matrix array. * \param dim matrix size. * \param lambda eigenvalues array. @@ -130,7 +130,7 @@ void MMG5_eigenvmat_buildnonsym(MMG5_pMesh mesh,int8_t dim,double m[], } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param m matrix array. * \param lambda eigenvalues array. * \param v double array of eigenvectors. @@ -150,7 +150,7 @@ int MMG5_eigenvmatsym2d(MMG5_pMesh mesh,double m[],double lambda[],double v[][2] } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param m matrix array. * \param lambda eigenvalues array. * \param v double array of eigenvectors. @@ -170,7 +170,7 @@ int MMG5_eigenvmatsym3d(MMG5_pMesh mesh,double m[],double lambda[],double v[][3] } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param m matrix array. * \param lambda eigenvalues array. * \param v double array of eigenvectors. @@ -195,7 +195,7 @@ int MMG5_eigenvmatnonsym2d(MMG5_pMesh mesh,double m[],double lambda[],double v[] } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param m matrix array. * \param lambda eigenvalues array. * \param v double array of eigenvectors. @@ -220,7 +220,7 @@ int MMG5_eigenvmatnonsym3d(MMG5_pMesh mesh,double m[],double lambda[],double v[] } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param dim matrix size. * \param symmat integer flag (1 if the matrix is symmetric, 0 otherwise). * \param m input matrix array. @@ -285,7 +285,7 @@ void MMG5_sort_eigenv( int8_t dim,double *lambda,double *vp, } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param mex test matrix array. * \param lambdaex exact eigenvalues array. * \param vpex double array of exact eigenvectors. @@ -362,7 +362,7 @@ int MMG5_test_eigenvmatsym2d(MMG5_pMesh mesh,double *mex,double lambdaex[], } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param mex test matrix array. * \param lambdaex exact eigenvalues array. * \param vpex double array of exact right eigenvectors. @@ -440,7 +440,7 @@ int MMG5_test_eigenvmatnonsym2d(MMG5_pMesh mesh,double *mex,double lambdaex[], } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param mex test matrix array. * \param lambdaex exact eigenvalues array. * \param vpex double array of exact eigenvectors. @@ -520,7 +520,7 @@ int MMG5_test_eigenvmatsym3d(MMG5_pMesh mesh,double *mex,double lambdaex[], } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param mex test matrix array. * \param lambdaex exact eigenvalues array. * \param vpex double array of exact right eigenvectors. @@ -584,7 +584,7 @@ int MMG5_test_eigenvmatnonsym3d(MMG5_pMesh mesh,double *mex,double lambdaex[], } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param t tangent at the ridge point. * \param n normal at the ridge point. * \param dtan metric size along the tangent direction. @@ -622,10 +622,10 @@ MMG5_buildridmetfic(MMG5_pMesh mesh,double t[3],double n[3],double dtan, } /** - * \param mesh pointer toward the mesh structure. - * \param m pointer toward the first metric to intersect. - * \param n pointer toward the second metric to intersect. - * \param mr pointer toward the computed intersected metric. + * \param mesh pointer to the mesh structure. + * \param m pointer to the first metric to intersect. + * \param n pointer to the second metric to intersect. + * \param mr pointer to the computed intersected metric. * \return 1. * * Compute the intersected (2 x 2) metric between metrics \a m and \a n, @@ -653,8 +653,8 @@ int MMG5_intmetsavedir(MMG5_pMesh mesh, double *m,double *n,double *mr) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the sol structure. * \param np0 index of edge's extremity. * \param ux distance \f$[p0;p1]\f$ along x axis. * \param uy distance \f$[p0;p1]\f$ along y axis. @@ -734,8 +734,8 @@ int MMG5_buildridmet(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int np0, } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the sol structure. * \param np0 index of edge's extremity. * \param nt normal direction at the ridge point. * \param mr computed metric tensor. @@ -801,9 +801,9 @@ int MMG5_buildridmetnor(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int np0,double nt[3], } /** - * \param mesh pointer toward the mesh structure. - * \param m pointer toward a \f$(2x2)\f$ metric. - * \param n pointer toward a \f$(2x2)\f$ metric. + * \param mesh pointer to the mesh structure. + * \param m pointer to a \f$(2x2)\f$ metric. + * \param n pointer to a \f$(2x2)\f$ metric. * \param mr computed \f$(2x2)\f$ metric. * \return 0 if fail, 1 otherwise. * @@ -911,9 +911,9 @@ int MMG5_intersecmet22(MMG5_pMesh mesh, double *m,double *n,double *mr) { } /** - * \param mesh pointer toward the mesh structure. - * \param m pointer toward a \f$(3x3)\f$ metric. - * \param n pointer toward a \f$(3x3)\f$ metric. + * \param mesh pointer to the mesh structure. + * \param m pointer to a \f$(3x3)\f$ metric. + * \param n pointer to a \f$(3x3)\f$ metric. * \param mr computed \f$(3x3)\f$ metric. * \return 0 if fail, 1 otherwise. * @@ -953,7 +953,7 @@ int MMG5_intersecmet33(MMG5_pMesh mesh, double *m,double *n,double *mr) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \return 0 if fail, 1 otherwise. * * Test the intersection of (2 x 2) metrics. @@ -1038,7 +1038,7 @@ int MMG5_test_intersecmet22(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \return 0 if fail, 1 otherwise. * * Test the intersection of (3 x 3) metrics. @@ -1123,8 +1123,8 @@ int MMG5_test_intersecmet33(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param np global index of vertex in which we intersect the metrics. * \param me physical metric at point \a np. * \param n normal or tangent at point np. diff --git a/src/common/mmg2.c b/src/common/mmg2.c index 6bb8a2e12..223ad1fd6 100644 --- a/src/common/mmg2.c +++ b/src/common/mmg2.c @@ -73,7 +73,7 @@ static int MMG5_InvMat_getIndex(MMG5_pInvMat pim,int ref) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param pim multimaterials inverse data table. * \param ref material reference. * \return the nosplit/split/plus/minus attribute of the material. @@ -120,7 +120,7 @@ static void MMG5_InvMat_error(MMG5_pInvMat pim,int ref,int k) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param pim multimaterials inverse data table. * \param k index of the material in the input table. * @@ -165,7 +165,7 @@ static int MMG5_InvMat_set(MMG5_pMesh mesh,MMG5_pInvMat pim,int k) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param pim multimaterials inverse data table. * \param ref material reference. * \param pref pointer to the parent material reference. @@ -201,7 +201,7 @@ static int MMG5_InvMat_getParent(MMG5_pMesh mesh,MMG5_pInvMat pim,MMG5_int ref,M } /** - * \param mesh pointer toward the mesh + * \param mesh pointer to the mesh * \param ref final reference for which we are searching the initial one * \param pref pointer to the reference of the parent material. * \return 1 if found, 0 otherwise. @@ -230,7 +230,7 @@ int MMG5_getStartRef(MMG5_pMesh mesh,MMG5_int ref,MMG5_int *pref) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param pim multimaterials inverse data table. * * Print materials lookup table. @@ -248,7 +248,7 @@ static void MMG5_InvMat_print(MMG5_pMesh mesh,MMG5_pInvMat pim) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \return 1 if success, 0 if fail. * * @@ -404,7 +404,7 @@ int MMG5_MultiMat_init(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param ref initial reference. * \param refint internal reference after ls discretization. * \param refext external reference after ls discretization. @@ -443,7 +443,7 @@ int MMG5_isSplit(MMG5_pMesh mesh,MMG5_int ref,MMG5_int *refint,MMG5_int *refext) } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param ref initial reference. * \return 1 if entity cannot be split, 0 if can be split. * @@ -466,7 +466,7 @@ int MMG5_isNotSplit(MMG5_pMesh mesh,MMG5_int ref) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param ref0 reference of the first tetrahedron sharing the face. * \param ref1 reference of the second tetrahedron sharing the face.. * \return 1 if face is on the discrete level set, 0 if not. @@ -497,8 +497,8 @@ int MMG5_isLevelSet(MMG5_pMesh mesh,MMG5_int ref0,MMG5_int ref1) { } /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the level-set function. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the level-set function. * \return 1 if success, 0 if fail. * * Snap values of the level set function very close to 0 to exactly 0, @@ -612,8 +612,8 @@ int MMG5_snpval_ls(MMG5_pMesh mesh,MMG5_pSol sol) { } /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the level-set values. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the level-set values. * \param start index of the starting tria * \param istart local index (inside the tria \a start) of the vertex that we check. * \return 1 if success, 0 if fail @@ -740,7 +740,7 @@ int MMG5_ismaniball(MMG5_pMesh mesh, MMG5_pSol sol, MMG5_int start, int8_t istar } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param ip0 First vertex of the triangle * \param ip1 Second vertex of the triangle * \param ip2 Third vertex of the triangle @@ -765,8 +765,8 @@ double MMG5_voltri(MMG5_pMesh mesh,MMG5_int ip0,MMG5_int ip1,MMG5_int ip2) { } /** - * \param mesh pointer toward the mesh structure - * \param sol pointer toward the ls function + * \param mesh pointer to the mesh structure + * \param sol pointer to the ls function * \param k index of the triangle * \param pm 1 for computation of positive subdomain, -1 for negative one * @@ -905,8 +905,8 @@ int MMG5_isbr(MMG5_pMesh mesh,MMG5_int ref) { } /** - * \param mesh pointer toward the mesh - * \param sol pointer toward the level-set + * \param mesh pointer to the mesh + * \param sol pointer to the level-set * * \return 1 if success, 0 otherwise * @@ -1186,7 +1186,7 @@ int MMG5_rmc(MMG5_pMesh mesh, MMG5_pSol sol){ } /** - * \param mesh pointer toward the mesh + * \param mesh pointer to the mesh * * Reset mesh->info.isoref vertex and edge references to 0. * @@ -1220,8 +1220,8 @@ int MMG5_resetRef_ls(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the level-set values. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the level-set values. * \return 1. * * Set references to tris according to the sign of the level set function. @@ -1296,7 +1296,7 @@ int MMG5_setref_ls(MMG5_pMesh mesh, MMG5_pSol sol) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param start index of starting tria. * \param istart local index of point that we check (in tria \a start) * \return 1 if the ball is manifold, 0 otherwise. @@ -1420,7 +1420,7 @@ int MMG5_chkmaniball(MMG5_pMesh mesh, MMG5_int start, int8_t istart) { } /** - * \param mesh pointer toward the mesh. + * \param mesh pointer to the mesh. * \return 1 if the mesh is manifold, 0 otherwise. * * Check whether the resulting two subdomains occupying mesh are manifold. diff --git a/src/common/mmg2s.c b/src/common/mmg2s.c index e35acd2a9..27ecf1f41 100644 --- a/src/common/mmg2s.c +++ b/src/common/mmg2s.c @@ -34,8 +34,8 @@ #include "mmgexterns_private.h" /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the level-set + * \param mesh pointer to the mesh structure. + * \param sol pointer to the level-set * * \return 1 if success, 0 if fail * @@ -121,7 +121,7 @@ int MMG5_snpval_lssurf(MMG5_pMesh mesh, MMG5_pSol sol) { } /** - * \param mesh pointer toward the mesh + * \param mesh pointer to the mesh * * Reset mesh->info.isoref vertex references to 0. * diff --git a/src/common/mmg3.c b/src/common/mmg3.c index 2fa6823d4..2285142d1 100644 --- a/src/common/mmg3.c +++ b/src/common/mmg3.c @@ -34,9 +34,9 @@ #include "mmgcommon_private.h" /** - * \param mesh pointer toward the mesh structure - * \param disp pointer toward the displacement field - * \param lastt 0 if a movement is possible, pointer toward the last tested fraction otherwise + * \param mesh pointer to the mesh structure + * \param disp pointer to the displacement field + * \param lastt 0 if a movement is possible, pointer to the last tested fraction otherwise * \param shortmax maximal parameter t (MMG2D_SHORTMAX or MMG3D_SHORTMAX) * \param chkmovmesh function that has to be called to check motion validity * @@ -103,8 +103,8 @@ short MMG5_dikmov ( MMG5_pMesh mesh,MMG5_pSol disp,short *lastt,short shortmax, } /** - * \param mesh pointer toward the mesh structure - * \param disp pointer toward the displacement field + * \param mesh pointer to the mesh structure + * \param disp pointer to the displacement field * * \return 1 if success, 0 if fail. * diff --git a/src/common/quality.c b/src/common/quality.c index 656480089..1590e2bfd 100644 --- a/src/common/quality.c +++ b/src/common/quality.c @@ -35,9 +35,9 @@ #include "mmgcommon_private.h" /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the meric structure. - * \param pt pointer toward the triangle structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the meric structure. + * \param pt pointer to the triangle structure. * \return The computed quality. * * Compute the quality of the surface triangle \a ptt with respect to @@ -101,9 +101,9 @@ double MMG5_caltri33_ani(MMG5_pMesh mesh,MMG5_pSol met,MMG5_pTria pt) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the meric structure. - * \param ptt pointer toward the triangle structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the meric structure. + * \param ptt pointer to the triangle structure. * \return The computed quality. * * Compute the quality of the surface triangle \a ptt with respect to @@ -187,9 +187,9 @@ double MMG5_caltri_ani(MMG5_pMesh mesh,MMG5_pSol met,MMG5_pTria ptt) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the meric structure. - * \param ptt pointer toward the triangle structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the meric structure. + * \param ptt pointer to the triangle structure. * \return The computed quality. * * Compute the quality of the surface triangle \a ptt with respect to @@ -231,9 +231,9 @@ inline double MMG5_caltri_iso(MMG5_pMesh mesh,MMG5_pSol met,MMG5_pTria ptt) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param ned edges number. - * \param avlen pointer toward the average edges lengths. + * \param avlen pointer to the average edges lengths. * \param amin index of first extremity of the smallest edge. * \param bmin index of second extremity of the smallest edge. * \param lmin smallest edge length. @@ -241,8 +241,8 @@ inline double MMG5_caltri_iso(MMG5_pMesh mesh,MMG5_pSol met,MMG5_pTria ptt) { * \param bmax index of second extremity of the largest edge. * \param lmax largest edge length. * \param nullEdge number of edges for which we are unable to compute the length - * \param bd pointer toward the table of the quality span. - * \param hl pointer toward the table that store the number of edges for eac + * \param bd pointer to the table of the quality span. + * \param hl pointer to the table that store the number of edges for eac * \param shift value to shift the target lenght interval * span of quality * @@ -282,8 +282,8 @@ void MMG5_displayLengthHisto(MMG5_pMesh mesh, MMG5_int ned, double *avlen, * \param bmax index of second extremity of the largest edge. * \param lmax largest edge length. * \param nullEdge number of edges for which we are unable to compute the length - * \param bd pointer toward the table of the quality span. - * \param hl pointer toward the table that store the number of edges for eac + * \param bd pointer to the table of the quality span. + * \param hl pointer to the table that store the number of edges for eac * \param shift value to shift the target lenght interval * span of quality * \param imprim verbosity level diff --git a/src/common/scalem.c b/src/common/scalem.c index 0d6053490..33155d91b 100644 --- a/src/common/scalem.c +++ b/src/common/scalem.c @@ -36,7 +36,7 @@ #include "mmgexterns_private.h" /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \return 1 if success, 0 if fail (computed bounding box too small). * * Compute the mesh bounding box and fill the \a min, \a max and \a delta fields @@ -78,7 +78,7 @@ int MMG5_boundingBox(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param sethmin 1 if hmin is setted by the user. * \param sethmax 1 if hmax is setted by the user. * @@ -107,7 +107,7 @@ void MMG5_check_hminhmax(MMG5_pMesh mesh, int8_t sethmin, int8_t sethmax) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \return 0 if fail, 1 if succeed * * Check that hmin (resp. hmax) is not user setted if it is negative. @@ -135,8 +135,8 @@ int MMG5_check_setted_hminhmax(MMG5_pMesh mesh) { } /** - * \param met pointer toward metric. - * \param ip pointer toward global index of point on which metric has to be truncated + * \param met pointer to metric. + * \param ip pointer to global index of point on which metric has to be truncated * \param isqhmin inverse square of hmin (min edge size) * \param isqhmax inverse square of hmax (max edge size) * @@ -192,8 +192,8 @@ int MMG5_truncate_met3d(MMG5_pSol met, MMG5_int ip, double isqhmin, double isqhm } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param dd scaling value. * * \return 1 if success, 0 if fail. @@ -246,8 +246,8 @@ int MMG5_scale_scalarMetric(MMG5_pMesh mesh, MMG5_pSol met, double dd) { /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param dd scaling value. * * \return 1 if success, 0 if fail. @@ -287,8 +287,8 @@ int MMG5_scale_tensorMetric(MMG5_pMesh mesh, MMG5_pSol met, double dd) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the solution structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the solution structure. * * \return 0 if fail, 1 if succeed. * @@ -353,8 +353,8 @@ int MMG5_solTruncature_iso(MMG5_pMesh mesh, MMG5_pSol met) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the solution structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the solution structure. * * \return 0 if fail, 1 if succeed. * @@ -441,8 +441,8 @@ int MMG5_2dSolTruncature_ani(MMG5_pMesh mesh, MMG5_pSol met) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the solution structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the solution structure. * * \return 0 if fail, 1 if succeed. * @@ -547,10 +547,10 @@ int MMG5_3dSolTruncature_ani(MMG5_pMesh mesh, MMG5_pSol met) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward a metric - * \param sol pointer toward a solution structure (level-set or displacement). - * \param dd pointer toward the scaling value (to fill) + * \param mesh pointer to the mesh structure. + * \param met pointer to a metric + * \param sol pointer to a solution structure (level-set or displacement). + * \param dd pointer to the scaling value (to fill) * * \return 1 if success, 0 if fail. * @@ -635,9 +635,9 @@ int MMG5_scale_meshAndSol(MMG5_pMesh mesh,MMG5_pSol met,MMG5_pSol sol,double *dd } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param sol pointer toward a solution structure (level-set or displacement). + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param sol pointer to a solution structure (level-set or displacement). * * \return 1 if success, 0 if fail (computed bounding box too small * or one af the anisotropic input metric is not valid). @@ -677,9 +677,9 @@ int MMG5_scaleMesh(MMG5_pMesh mesh,MMG5_pSol met,MMG5_pSol sol) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward a metric. - * \param sol pointer toward a solution structure (level-set or displacement). + * \param mesh pointer to the mesh structure. + * \param met pointer to a metric. + * \param sol pointer to a solution structure (level-set or displacement). * * \return 1. * diff --git a/src/common/tools.c b/src/common/tools.c index 0faf1891c..7578d6f3f 100644 --- a/src/common/tools.c +++ b/src/common/tools.c @@ -114,7 +114,7 @@ int MMG5_devangle(double* n1, double *n2, double crit) } /** - * \param mesh pointer toward the mesh stucture. + * \param mesh pointer to the mesh stucture. * \param ip1 first point of face. * \param ip2 second point of face. * \param ip3 third point of face. @@ -150,7 +150,7 @@ inline int MMG5_nonUnitNorPts(MMG5_pMesh mesh, } /** - * \param mesh pointer toward the mesh stucture. + * \param mesh pointer to the mesh stucture. * \param pt triangle for which we compute the surface. * \return the computed surface * @@ -170,7 +170,7 @@ inline double MMG5_nonorsurf(MMG5_pMesh mesh,MMG5_pTria pt) { return n[0]*n[0] + n[1]*n[1] + n[2]*n[2]; } /** - * \param mesh pointer toward the mesh stucture. + * \param mesh pointer to the mesh stucture. * \param ip1 first point of face. * \param ip2 second point of face. * \param ip3 third point of face. @@ -198,8 +198,8 @@ inline int MMG5_norpts(MMG5_pMesh mesh,MMG5_int ip1,MMG5_int ip2, MMG5_int ip3,d } /** - * \param mesh pointer toward the mesh stucture. - * \param pt pointer toward the triangle structure. + * \param mesh pointer to the mesh stucture. + * \param pt pointer to the triangle structure. * \param n pointer to store the computed normal. * \return 1 * @@ -456,7 +456,7 @@ inline int MMG5_test_rmtr() { } /** - * \param n pointer toward the vector that we want to send on the third vector + * \param n pointer to the vector that we want to send on the third vector * of canonical basis. * \param r computed rotation matrix. * @@ -553,8 +553,8 @@ int MMG5_test_rotmatrix() { } /** - * \param m pointer toward a 3x3 symetric matrix - * \param mi pointer toward the computed 3x3 matrix. + * \param m pointer to a 3x3 symetric matrix + * \param mi pointer to the computed 3x3 matrix. * * Invert \a m (3x3 symetric matrix) and store the result on \a mi * @@ -816,8 +816,8 @@ inline int MMG5_sys33sym(double a[6], double b[3], double r[3]){ } /** - * \param mesh pointer toward the mesh structure. - * \param fileName pointer toward the file name. + * \param mesh pointer to the mesh structure. + * \param fileName pointer to the file name. * * Debug function (not use in clean code): write mesh->tria structure in file. * @@ -882,7 +882,7 @@ size_t MMG5_memSize (void) { } /** - * \param mesh pointer toward the mesh structure + * \param mesh pointer to the mesh structure * * Set the memMax value to its "true" value if memory asked by * user. Here the MMG5_MEMPERCENT coef is already applied on memMax. @@ -941,7 +941,7 @@ inline double MMG5_det4pt(double c0[3],double c1[3],double c2[3],double c3[3]) { /** * \param point Pointer toward the points array - * \param v pointer toward the point indices + * \param v pointer to the point indices * * \return the oriented volume of tetra * @@ -986,7 +986,7 @@ double MMG2D_quickarea(double a[2],double b[2],double c[2]) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * * Mark all mesh vertices as unused. * @@ -1008,7 +1008,7 @@ void MMG5_mark_verticesAsUnused ( MMG5_pMesh mesh ) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param delPt function to call to delete point. * * Mark the mesh vertices that belong to triangles or quadrangles as used (for @@ -1062,7 +1062,7 @@ void MMG5_mark_usedVertices ( MMG5_pMesh mesh,void (*delPt)(MMG5_pMesh,MMG5_int) } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param nsd subdomain index. * \param delElt function to call to delete elt. * diff --git a/src/mmg2d/analys_2d.c b/src/mmg2d/analys_2d.c index 9a0442864..20bd8a9b8 100644 --- a/src/mmg2d/analys_2d.c +++ b/src/mmg2d/analys_2d.c @@ -37,7 +37,7 @@ extern int8_t ddb; /** - * \param mesh pointer toward the mesh + * \param mesh pointer to the mesh * \param init_cc 1 if we need to reinitialized \a cc field of tria because * setadj has already been called (isosurf mode) * @@ -268,7 +268,7 @@ int MMG2D_setadj(MMG5_pMesh mesh, int8_t init_cc) { } /** - * \param mesh pointer toward the mesh structure + * \param mesh pointer to the mesh structure * \param ref reference of the boundary to analyze (analyze all the boundaries * if MMG5_UNSET) * @@ -402,7 +402,7 @@ int MMG2D_singul(MMG5_pMesh mesh, MMG5_int ref ) { } /** - * \param mesh pointer toward the mesh structure + * \param mesh pointer to the mesh structure * \param ref reference of the boundary to analyze (analyze all the boundaries * if MMG5_UNSET) * @@ -508,7 +508,7 @@ int MMG2D_norver(MMG5_pMesh mesh, MMG5_int ref) { } /** - * \param mesh pointer toward the mesh + * \param mesh pointer to the mesh * * \return 0 if fail, 1 if success * @@ -773,8 +773,8 @@ int MMG2D_regnor(MMG5_pMesh mesh) { } /** - * \param mesh pointer towards the mesh - * \param pt pointer towards current triangle + * \param mesh pointer tos the mesh + * \param pt pointer tos current triangle * \param k number of current point * \param c newly computed coordinates (giving negative area) * @@ -842,7 +842,7 @@ static inline int MMG2D_dichotomy(MMG5_pMesh mesh, MMG5_pTria pt, MMG5_int k, do /** - * \param mesh pointer toward the mesh + * \param mesh pointer to the mesh * * \return 0 if fail, 1 if success * diff --git a/src/mmg2d/anisosiz_2d.c b/src/mmg2d/anisosiz_2d.c index 9e95cb5ef..23a5b6398 100644 --- a/src/mmg2d/anisosiz_2d.c +++ b/src/mmg2d/anisosiz_2d.c @@ -36,8 +36,8 @@ #include "mmg2dexterns_private.h" /** - * \param mesh pointer toward the mesh - * \param met pointer toward the metric + * \param mesh pointer to the mesh + * \param met pointer to the metric * \param k elt index * \param i vertex index in triangle \a k * @@ -70,8 +70,8 @@ int MMG2D_defaultmet_2d(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int k,int8_t i) { } /** - * \param mesh pointer toward the mesh - * \param met pointer toward the metric + * \param mesh pointer to the mesh + * \param met pointer to the metric * \param k index of the tria in which we work * \param i index of the point on which we want to compute the metric * @@ -352,8 +352,8 @@ int MMG2D_defmetbdy_2d(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int k,int8_t i) { } /** - * \param mesh pointer toward the mesh - * \param met pointer toward the metric + * \param mesh pointer to the mesh + * \param met pointer to the metric * * \return 0 if fail, 1 if success * @@ -518,9 +518,9 @@ void MMG2D_gradEigenv(double dm[2],double dn[2],double difsiz,int8_t dir,int8_t } /** - * \param mesh pointer toward the mesh - * \param met pointer toward the metric - * \param pt pointer toward the processed triangle. + * \param mesh pointer to the mesh + * \param met pointer to the metric + * \param pt pointer to the processed triangle. * \param np1 first edge extremity (global index) * \param np2 second edge extremity (global index) * @@ -581,9 +581,9 @@ MMG5_int MMG2D_grad2met_ani(MMG5_pMesh mesh,MMG5_pSol met,MMG5_pTria pt,MMG5_int } /** - * \param mesh pointer toward the mesh - * \param met pointer toward the metric - * \param pt pointer toward the processed tria. + * \param mesh pointer to the mesh + * \param met pointer to the metric + * \param pt pointer to the processed tria. * \param npmaster edge extremity that cannot be modified * \param npslave edge extremity to modify to respect the gradation. * diff --git a/src/mmg2d/boulep_2d.c b/src/mmg2d/boulep_2d.c index bf3681fdb..68ed1dd03 100644 --- a/src/mmg2d/boulep_2d.c +++ b/src/mmg2d/boulep_2d.c @@ -92,7 +92,7 @@ int MMG2D_boulep(MMG5_pMesh mesh, MMG5_int ifirst, int iploc, MMG5_int * list) { } /** - * \param mesh pointer toward the mesh + * \param mesh pointer to the mesh * \param start index of the first tria * \param ip local index of the point on which we work in tria \a start * \param pleft index of the left point of ip along the geom edge @@ -219,7 +219,7 @@ int MMG2D_boulen(MMG5_pMesh mesh, MMG5_int start,int8_t ip, MMG5_int *pleft, MMG } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param start index of triangle to start. * \param ip index of point for wich we compute the ball. * \return 1 if success, 0 if fail. diff --git a/src/mmg2d/chkmsh_2d.c b/src/mmg2d/chkmsh_2d.c index 1725b2c15..3039da59a 100644 --- a/src/mmg2d/chkmsh_2d.c +++ b/src/mmg2d/chkmsh_2d.c @@ -25,7 +25,7 @@ #include "libmmg2d_private.h" /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param severe level of performed check * \param base 1 if we want to test opnbdy edge tags (consistent only after analysis) * \return 0 if fail, 1 if success. diff --git a/src/mmg2d/colver_2d.c b/src/mmg2d/colver_2d.c index e179b5c28..1b4572081 100644 --- a/src/mmg2d/colver_2d.c +++ b/src/mmg2d/colver_2d.c @@ -26,8 +26,8 @@ extern uint8_t ddb; /** - * \param mesh pointer toward the mesh - * \param met pointer toward the metric + * \param mesh pointer to the mesh + * \param met pointer to the metric * \param k triangle index * \param i local index of the edge that we want to test in the triangle \a k * \param list edge's shell (to fill) diff --git a/src/mmg2d/delone_2d.c b/src/mmg2d/delone_2d.c index 64b74c295..45e258800 100644 --- a/src/mmg2d/delone_2d.c +++ b/src/mmg2d/delone_2d.c @@ -92,8 +92,8 @@ static int MMG2D_correction_iso(MMG5_pMesh mesh,MMG5_int ip,MMG5_int *list,int i } /** - * \param mesh pointer toward the mesh structure - * \param hash pointer toward the hash table structure + * \param mesh pointer to the mesh structure + * \param hash pointer to the hash table structure * \param iel index of triangle * \param i index of the face of the element * @@ -237,8 +237,8 @@ int MMG2D_cavity(MMG5_pMesh mesh,MMG5_pSol sol,MMG5_int ip,MMG5_int *list) { } /** - * \param mesh pointer toward the mesh - * \param sol pointer toward the solution (metric) structure + * \param mesh pointer to the mesh + * \param sol pointer to the solution (metric) structure * \param ip index of point to insert * \param list Cavity of the point \a ip. * \param ilist number of trias in the cavity of \a ip. diff --git a/src/mmg2d/enforcement_2d.c b/src/mmg2d/enforcement_2d.c index ef5611815..490c7929f 100644 --- a/src/mmg2d/enforcement_2d.c +++ b/src/mmg2d/enforcement_2d.c @@ -24,8 +24,8 @@ /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure. * \return 0 if fail, 1 otherwise. * * Check if all edges exist in the mesh and if not force them. diff --git a/src/mmg2d/hash_2d.c b/src/mmg2d/hash_2d.c index 77d0feb67..f81a0e4b3 100644 --- a/src/mmg2d/hash_2d.c +++ b/src/mmg2d/hash_2d.c @@ -26,7 +26,7 @@ #define KTB 11 /** - * \param mesh pointer toward the mesh + * \param mesh pointer to the mesh * \return 1 if success, 0 if fail * * Create adjacency relations between the triangles in the mesh @@ -141,7 +141,7 @@ int MMG2D_hashTria(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * * \return 0 if failed, 1 otherwise. * @@ -334,7 +334,7 @@ int MMG2D_hashQuad(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh + * \param mesh pointer to the mesh * * \return 0 if fail, 1 otherwise * @@ -445,7 +445,7 @@ int MMG2D_assignEdge(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh + * \param mesh pointer to the mesh * * \return 1 if success, 0 if fail * @@ -527,9 +527,9 @@ int MMG2D_bdryEdge(MMG5_pMesh mesh) { /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward a solution structure. - * \param met pointer toward a solution structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to a solution structure. + * \param met pointer to a solution structure. * * \return 0 if memory problem (uncomplete mesh), 1 otherwise. * diff --git a/src/mmg2d/inout_2d.c b/src/mmg2d/inout_2d.c index 2ace1decc..a2e57dad1 100644 --- a/src/mmg2d/inout_2d.c +++ b/src/mmg2d/inout_2d.c @@ -664,7 +664,7 @@ int MMG2D_loadGenericMesh(MMG5_pMesh mesh, MMG5_pSol met, MMG5_pSol sol, const c /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \return 0 if failed, 1 otherwise. * * Check mesh data for a Msh mesh : mark the vertices as used if no triangles in @@ -827,8 +827,8 @@ int MMG2D_loadMshMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol,const char *fil } /** - * \param sol pointer toward an allocatable sol structure. - * \param inm pointer toward the solution file + * \param sol pointer to an allocatable sol structure. + * \param inm pointer to the solution file * \param bin 1 if binary file * \param iswp Endianess * \param index of the readed solution @@ -858,8 +858,8 @@ int MMG2D_readFloatSol(MMG5_pSol sol,FILE *inm,int bin,int iswp,MMG5_int pos) { } /** - * \param sol pointer toward an allocatable sol structure. - * \param inm pointer toward the solution file + * \param sol pointer to an allocatable sol structure. + * \param inm pointer to the solution file * \param bin 1 if binary file * \param iswp Endianess * \param index of the readed solution @@ -889,8 +889,8 @@ int MMG2D_readDoubleSol(MMG5_pSol sol,FILE *inm,int bin,int iswp,MMG5_int pos) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the sol structure. * \param filename name of file. * \return -1 data invalid or we fail, 0 no file, 1 ok. * @@ -980,8 +980,8 @@ int MMG2D_loadSol(MMG5_pMesh mesh,MMG5_pSol sol,const char *filename) { } /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward an allocatable sol structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to an allocatable sol structure. * \param filename name of file. * \return -1 data invalid or we fail, 0 no file, 1 ok. * @@ -1537,8 +1537,8 @@ int MMG2D_saveMshMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol,const char *fil } /** - * \param sol pointer toward an allocatable sol structure. - * \param inm pointer toward the solution file + * \param sol pointer to an allocatable sol structure. + * \param inm pointer to the solution file * \param bin 1 if binary file * \param index of the writted solution * \param gmsh write in 3D (for gmsh) if 1 @@ -1601,8 +1601,8 @@ void MMG2D_writeDoubleSol(MMG5_pSol sol,FILE *inm,int bin,MMG5_int pos,int gmsh) /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the sol structure. * \param filename name of file. * \return 0 if failed, 1 otherwise. * @@ -1662,8 +1662,8 @@ int MMG2D_saveSol(MMG5_pMesh mesh,MMG5_pSol sol,const char *filename) { } /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solutions array. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solutions array. * \param filename name of file. * \return 0 if failed, 1 otherwise. * diff --git a/src/mmg2d/isosiz_2d.c b/src/mmg2d/isosiz_2d.c index 88111d5c3..2561ad2b4 100644 --- a/src/mmg2d/isosiz_2d.c +++ b/src/mmg2d/isosiz_2d.c @@ -37,8 +37,8 @@ #include "mmgexterns_private.h" /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param pt tetra to process. * \param i index of the edge of the tetra \a pt that we process. * @@ -63,8 +63,8 @@ int MMG2D_sum_reqEdgeLengthsAtPoint(MMG5_pMesh mesh,MMG5_pSol met,MMG5_pTria pt, /** - * \param mesh pointer toward the mesh - * \param met pointer toward the metric + * \param mesh pointer to the mesh + * \param met pointer to the metric * \param ismet 1 if user provided metric * * \return 0 if fail, 1 otherwise @@ -121,8 +121,8 @@ return 1; } /** - * \param mesh pointer toward the mesh - * \param met pointer toward the metric + * \param mesh pointer to the mesh + * \param met pointer to the metric * * \return 0 if fail, 1 otherwise * diff --git a/src/mmg2d/libmmg2d.c b/src/mmg2d/libmmg2d.c index d94ab689f..892b95297 100644 --- a/src/mmg2d/libmmg2d.c +++ b/src/mmg2d/libmmg2d.c @@ -261,7 +261,7 @@ int MMG2D_mmg2dlib(MMG5_pMesh mesh,MMG5_pSol met) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \return 0 if fail (lack of memory), 1 otherwise. * * Clean the mesh structure when we just call the MMG2D_Free_Triangles and diff --git a/src/mmg2d/libmmg2d.h b/src/mmg2d/libmmg2d.h index 6f0fde300..1e6540587 100644 --- a/src/mmg2d/libmmg2d.h +++ b/src/mmg2d/libmmg2d.h @@ -123,8 +123,8 @@ extern "C" { LIBMMG2D_EXPORT int MMG2D_Init_mesh(const int starter,...); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure. * * Initialize file names to their default values. * @@ -137,7 +137,7 @@ extern "C" { LIBMMG2D_EXPORT void MMG2D_Init_fileNames(MMG5_pMesh mesh, MMG5_pSol sol); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * * Initialization of the input parameters (stored in the Info structure). * @@ -151,7 +151,7 @@ extern "C" { /* init file names */ /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param meshin input mesh name. * \return 1. * @@ -168,7 +168,7 @@ extern "C" { */ LIBMMG2D_EXPORT int MMG2D_Set_inputMeshName(MMG5_pMesh mesh, const char* meshin); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param meshout name of the output mesh file. * \return 1. * @@ -185,8 +185,8 @@ extern "C" { */ LIBMMG2D_EXPORT int MMG2D_Set_outputMeshName(MMG5_pMesh mesh, const char* meshout); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure. * \param solin name of the input solution file. * \return 1. * @@ -203,8 +203,8 @@ extern "C" { */ LIBMMG2D_EXPORT int MMG2D_Set_inputSolName(MMG5_pMesh mesh,MMG5_pSol sol, const char* solin); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure. * \param solout name of the output solution file. * \return 0 if failed, 1 otherwise. * @@ -221,7 +221,7 @@ extern "C" { */ LIBMMG2D_EXPORT int MMG2D_Set_outputSolName(MMG5_pMesh mesh,MMG5_pSol sol, const char* solout); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param fparamin name of the input parameter file. * \return 1. * @@ -238,8 +238,8 @@ extern "C" { */ LIBMMG2D_EXPORT int MMG2D_Set_inputParamName(MMG5_pMesh mesh, const char* fparamin); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure (unused). + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure (unused). * \param iparam integer parameter to set (see \a MMG2D_Param structure). * \param val value for the parameter. * \return 0 if failed, 1 otherwise. @@ -259,8 +259,8 @@ extern "C" { LIBMMG2D_EXPORT int MMG2D_Set_iparameter(MMG5_pMesh mesh, MMG5_pSol sol, int iparam, MMG5_int val); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure. * \param dparam double parameter to set (see \a MMG2D_Param structure). * \param val value of the parameter. * \return 0 if failed, 1 otherwise. @@ -280,8 +280,8 @@ extern "C" { LIBMMG2D_EXPORT int MMG2D_Set_dparameter(MMG5_pMesh mesh, MMG5_pSol sol, int dparam, double val); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure. * \param typ type of entity (triangle, edge,...). * \param ref reference of the entity. * \param hmin minimal edge size. @@ -307,8 +307,8 @@ extern "C" { MMG5_int ref,double hmin,double hmax,double hausd); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure. * \param ref input tetra reference. * \param split MMG5_MMAT_NoSplit if the entity must not be splitted, MMG5_MMAT_Split otherwise * \param rin internal reference after ls discretization @@ -330,8 +330,8 @@ extern "C" { MMG5_int rin, MMG5_int rex); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure. * \param br new level-set base reference. * \return 0 if failed, 1 otherwise. * @@ -353,7 +353,7 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM /* init structure datas */ /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param np number of vertices. * \param nt number of triangles. * \param nquad number of quads. @@ -374,8 +374,8 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG2D_EXPORT int MMG2D_Set_meshSize(MMG5_pMesh mesh, MMG5_int np, MMG5_int nt, MMG5_int nquad, MMG5_int na); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure. * \param typEntity type of solutions entities (vertices, triangles...). * \param np number of solutions. * \param typSol type of solution (scalar, vectorial...). @@ -398,8 +398,8 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG2D_EXPORT int MMG2D_Set_solSize(MMG5_pMesh mesh, MMG5_pSol sol, int typEntity, MMG5_int np, int typSol); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward an allocatable sol structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to an allocatable sol structure. * \param nsols number of solutions per entity * \param nentities number of entities * \param typSol Array of size nsol listing the type of the solutions @@ -424,7 +424,7 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG2D_EXPORT int MMG2D_Set_solsAtVerticesSize(MMG5_pMesh mesh, MMG5_pSol *sol,int nsols, MMG5_int nentities, int *typSol); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param c0 coordinate of the point along the first dimension. * \param c1 coordinate of the point along the second dimension. * \param ref point reference. @@ -446,7 +446,7 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG2D_EXPORT int MMG2D_Set_vertex(MMG5_pMesh mesh, double c0, double c1, MMG5_int ref,MMG5_int pos); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param vertices table of the points coor. * The coordinates of the \f$i^{th}\f$ point are stored in * vertices[(i-1)*2]\@2 @@ -469,7 +469,7 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG2D_EXPORT int MMG2D_Set_vertices(MMG5_pMesh mesh, double *vertices,MMG5_int *refs); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param k vertex index. * \return 1. * @@ -486,7 +486,7 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG2D_EXPORT int MMG2D_Set_corner(MMG5_pMesh mesh, MMG5_int k); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param k vertex index. * \return 1. * @@ -504,7 +504,7 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG2D_EXPORT int MMG2D_Unset_corner(MMG5_pMesh mesh, MMG5_int k); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param k vertex index. * \return 1. * @@ -521,7 +521,7 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG2D_EXPORT int MMG2D_Set_requiredVertex(MMG5_pMesh mesh, MMG5_int k); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param k vertex index. * \return 1. * @@ -538,7 +538,7 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG2D_EXPORT int MMG2D_Unset_requiredVertex(MMG5_pMesh mesh, MMG5_int k); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param v0 first vertex of triangle. * \param v1 second vertex of triangle. * \param v2 third vertex of triangle. @@ -560,10 +560,10 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG2D_EXPORT int MMG2D_Set_triangle(MMG5_pMesh mesh, MMG5_int v0, MMG5_int v1, MMG5_int v2, MMG5_int ref, MMG5_int pos); /** - * \param mesh pointer toward the mesh structure. - * \param tria pointer toward the table of the tria vertices. + * \param mesh pointer to the mesh structure. + * \param tria pointer to the table of the tria vertices. * Vertices of the \f$i^{th}\f$ tria are stored in tria[(i-1)*3]\@3. - * \param refs pointer toward the table of the triangle references. + * \param refs pointer to the table of the triangle references. * refs[i-1] is the ref of the \f$i^{th}\f$ tria. * \return 0 if failed, 1 otherwise. * @@ -581,7 +581,7 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG2D_EXPORT int MMG2D_Set_triangles(MMG5_pMesh mesh, MMG5_int *tria, MMG5_int *refs); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param k triangle index. * \return 1. * @@ -598,7 +598,7 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG2D_EXPORT int MMG2D_Set_requiredTriangle(MMG5_pMesh mesh, MMG5_int k); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param k triangle index. * \return 1. * @@ -615,7 +615,7 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG2D_EXPORT int MMG2D_Unset_requiredTriangle(MMG5_pMesh mesh, MMG5_int k); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param v0 first vertex of quadrilateral. * \param v1 second vertex of quadrilateral. * \param v2 third vertex of quadrilateral. @@ -639,7 +639,7 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM MMG5_int v2, MMG5_int v3, MMG5_int ref, MMG5_int pos); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param quadra vertices of the quadrilaterals of the mesh * Vertices of the \f$i^{th}\f$ quadrilateral are stored in quadra[(i-1)*4]\@4. * \param refs table of the quadrangles references. @@ -662,7 +662,7 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM MMG5_int *refs); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param v0 first vertex of edge. * \param v1 second vertex of edge. * \param ref edge reference. @@ -683,8 +683,8 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG2D_EXPORT int MMG2D_Set_edge(MMG5_pMesh mesh, MMG5_int v0, MMG5_int v1, MMG5_int ref, MMG5_int pos); /** - * \param mesh pointer toward the mesh structure. - * \param edges pointer toward the array of edges. + * \param mesh pointer to the mesh structure. + * \param edges pointer to the array of edges. * Vertices of the \f$i^{th}\f$ edge are stored in edge[(i-1)*2]\@2. * \param refs edges references. refs[i-1] is the ref of the \f$i^{th}\f$ edge. * \return 0 if failed, 1 otherwise. @@ -701,7 +701,7 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG2D_EXPORT int MMG2D_Set_edges(MMG5_pMesh mesh, MMG5_int *edges, MMG5_int* refs); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param k edge index. * \return 1. * @@ -717,7 +717,7 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG2D_EXPORT int MMG2D_Set_requiredEdge(MMG5_pMesh mesh, MMG5_int k); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param k edge index. * \return 1. * @@ -733,7 +733,7 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG2D_EXPORT int MMG2D_Unset_requiredEdge(MMG5_pMesh mesh, MMG5_int k); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param k edge index. * \return 1. * @@ -749,7 +749,7 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG2D_EXPORT int MMG2D_Set_parallelEdge(MMG5_pMesh mesh, MMG5_int k); /** - * \param met pointer toward the sol structure. + * \param met pointer to the sol structure. * \param s solution scalar value. * \param pos position of the solution in the mesh. * \return 0 if failed, 1 otherwise. @@ -768,7 +768,7 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG2D_EXPORT int MMG2D_Set_scalarSol(MMG5_pSol met, double s, MMG5_int pos); /** - * \param met pointer toward the sol structure. + * \param met pointer to the sol structure. * \param s table of the scalar solutions values. * s[i-1] is the solution at vertex i. * \return 0 if failed, 1 otherwise. @@ -785,7 +785,7 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG2D_EXPORT int MMG2D_Set_scalarSols(MMG5_pSol met, double *s); /** - * \param met pointer toward the sol structure. + * \param met pointer to the sol structure. * \param vx x value of the vectorial solution. * \param vy y value of the vectorial solution. * \param pos position of the solution in the mesh (begin to 1). @@ -806,7 +806,7 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG2D_EXPORT int MMG2D_Set_vectorSol(MMG5_pSol met, double vx,double vy, MMG5_int pos); /** - * \param met pointer toward the sol structure. + * \param met pointer to the sol structure. * \param sols table of the vectorial solutions * sols[2*(i-1)]\@2 is the solution at vertex i * \return 0 if failed, 1 otherwise. @@ -823,7 +823,7 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG2D_EXPORT int MMG2D_Set_vectorSols(MMG5_pSol met, double *sols); /** - * \param met pointer toward the sol structure. + * \param met pointer to the sol structure. * \param m11 value at position (1,1) in the solution tensor. * \param m12 value at position (1,2) in the solution tensor. * \param m22 value at position (2,2) in the solution tensor. @@ -845,7 +845,7 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG2D_EXPORT int MMG2D_Set_tensorSol(MMG5_pSol met, double m11, double m12, double m22, MMG5_int pos); /** - * \param met pointer toward the sol structure. + * \param met pointer to the sol structure. * \param sols table of the tensorial solutions. * sols[3*(i-1)]\@3 is the solution at vertex i * \return 0 if failed, 1 otherwise. @@ -863,7 +863,7 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG2D_EXPORT int MMG2D_Set_tensorSols(MMG5_pSol met, double *sols); /** - * \param sol pointer toward the array of solutions + * \param sol pointer to the array of solutions * \param i position of the solution field that we want to set. * \param s solution(s) at mesh vertex \a pos. * \param pos index of the vertex on which we set the solution. @@ -885,7 +885,7 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG2D_EXPORT int MMG2D_Set_ithSol_inSolsAtVertices(MMG5_pSol sol,int i, double* s,MMG5_int pos); /** - * \param sol pointer toward the array of solutions + * \param sol pointer to the array of solutions * \param i position of the solution field that we want to set. * \param s table of the solutions at mesh vertices. The solution at vertex \a k * is given by s[k-1] for a scalar sol, s[2*(k-1)]\@2 for a vectorial solution @@ -909,11 +909,11 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM /** recover datas */ /** - * \param mesh pointer toward the mesh structure. - * \param np pointer toward the number of vertices. - * \param nt pointer toward the number of triangles. - * \param nquad pointer toward the number of quads. - * \param na pointer toward the number of edges. + * \param mesh pointer to the mesh structure. + * \param np pointer to the number of vertices. + * \param nt pointer to the number of triangles. + * \param nquad pointer to the number of quads. + * \param na pointer to the number of edges. * \return 1. * * Get the number of vertices, triangles and edges of the mesh. @@ -928,11 +928,11 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG2D_EXPORT int MMG2D_Get_meshSize(MMG5_pMesh mesh, MMG5_int* np, MMG5_int* nt, MMG5_int* nquad, MMG5_int* na); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure. - * \param typEntity pointer toward the type of entities to which solutions are applied. - * \param np pointer toward the number of solutions. - * \param typSol pointer toward the type of the solutions (scalar, vectorial...) + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure. + * \param typEntity pointer to the type of entities to which solutions are applied. + * \param np pointer to the number of solutions. + * \param typSol pointer to the type of the solutions (scalar, vectorial...) * \return 1. * * Get the solution number, dimension and type. @@ -949,9 +949,9 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG2D_EXPORT int MMG2D_Get_solSize(MMG5_pMesh mesh, MMG5_pSol sol, int* typEntity, MMG5_int* np, int* typSol); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward an array of sol structure. - * \param nentities pointer toward the number of entities. + * \param mesh pointer to the mesh structure. + * \param sol pointer to an array of sol structure. + * \param nentities pointer to the number of entities. * \param typSol array of size MMG5_NSOL_MAX to store type of each solution * (scalar, vector..). * @@ -972,12 +972,12 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG2D_EXPORT int MMG2D_Get_solsAtVerticesSize(MMG5_pMesh mesh, MMG5_pSol* sol,int *nsols, MMG5_int* nentities,int* typSol); /** - * \param mesh pointer toward the mesh structure. - * \param c0 pointer toward the coordinate of the point along the first dimension. - * \param c1 pointer toward the coordinate of the point along the second dimension. + * \param mesh pointer to the mesh structure. + * \param c0 pointer to the coordinate of the point along the first dimension. + * \param c1 pointer to the coordinate of the point along the second dimension. * \param ref pointer to the point reference. - * \param isCorner pointer toward the flag saying if point is corner. - * \param isRequired pointer toward the flag saying if point is required. + * \param isCorner pointer to the flag saying if point is corner. + * \param isRequired pointer to the flag saying if point is required. * \return 1. * * Get coordinates \a c0, \a c1 and reference \a ref of @@ -996,12 +996,12 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG2D_EXPORT int MMG2D_Get_vertex(MMG5_pMesh mesh, double* c0, double* c1, MMG5_int* ref, int* isCorner, int* isRequired); /** - * \param mesh pointer toward the mesh structure. - * \param c0 pointer toward the coordinate of the point along the first dimension. - * \param c1 pointer toward the coordinate of the point along the second dimension. + * \param mesh pointer to the mesh structure. + * \param c0 pointer to the coordinate of the point along the first dimension. + * \param c1 pointer to the coordinate of the point along the second dimension. * \param ref pointer to the point reference. - * \param isCorner pointer toward the flag saying if point is corner. - * \param isRequired pointer toward the flag saying if point is required. + * \param isCorner pointer to the flag saying if point is corner. + * \param isRequired pointer to the flag saying if point is required. * \param idx index of point to get. * \return 1. * @@ -1021,16 +1021,16 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG2D_EXPORT int MMG2D_GetByIdx_vertex(MMG5_pMesh mesh, double* c0, double* c1, MMG5_int* ref, int* isCorner, int* isRequired,MMG5_int idx); /** - * \param mesh pointer toward the mesh structure. - * \param vertices pointer toward the table of the points coordinates. + * \param mesh pointer to the mesh structure. + * \param vertices pointer to the table of the points coordinates. * The coordinates of the \f$i^{th}\f$ point are stored in * vertices[(i-1)*2]\@2. * \param refs pointer to the table of the point references. * The ref of the \f$i^th\f$ point is stored in refs[i-1]. - * \param areCorners pointer toward the table of the flags saying if + * \param areCorners pointer to the table of the flags saying if * points are corners. * areCorners[i-1]=1 if the \f$i^{th}\f$ point is corner. - * \param areRequired pointer toward the table of flags saying if points + * \param areRequired pointer to the table of flags saying if points * are required. areRequired[i-1]=1 if the \f$i^{th}\f$ point is required. * \return 1. * @@ -1051,12 +1051,12 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG2D_EXPORT int MMG2D_Get_vertices(MMG5_pMesh mesh, double* vertices, MMG5_int* refs, int* areCorners, int* areRequired); /** - * \param mesh pointer toward the mesh structure. - * \param v0 pointer toward the first vertex of triangle. - * \param v1 pointer toward the second vertex of triangle. - * \param v2 pointer toward the third vertex of triangle. - * \param ref pointer toward the triangle reference. - * \param isRequired pointer toward the flag saying if triangle is required. + * \param mesh pointer to the mesh structure. + * \param v0 pointer to the first vertex of triangle. + * \param v1 pointer to the second vertex of triangle. + * \param v2 pointer to the third vertex of triangle. + * \param ref pointer to the triangle reference. + * \param isRequired pointer to the flag saying if triangle is required. * \return 0 if failed, 1 otherwise. * * Get vertices \a v0,\a v1,\a v2 and reference \a ref of next @@ -1076,12 +1076,12 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM MMG5_int* v1, MMG5_int* v2, MMG5_int* ref ,int* isRequired); /** - * \param mesh pointer toward the mesh structure. - * \param tria pointer toward the table of the triangles vertices + * \param mesh pointer to the mesh structure. + * \param tria pointer to the table of the triangles vertices * Vertices of the \f$i^{th}\f$ tria are stored in tria[(i-1)*3]\@3. - * \param refs pointer toward the table of the triangles references. + * \param refs pointer to the table of the triangles references. * refs[i-1] is the ref of the \f$i^{th}\f$ tria. - * \param areRequired pointer toward table of the flags saying if triangles + * \param areRequired pointer to table of the flags saying if triangles * are required. areRequired[i-1]=1 if the \f$i^{th}\f$ tria * is required. * \return 0 if failed, 1 otherwise. @@ -1103,13 +1103,13 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM int* areRequired); /** - * \param mesh pointer toward the mesh structure. - * \param v0 pointer toward the first vertex of quadrangle. - * \param v1 pointer toward the second vertex of quadrangle. - * \param v2 pointer toward the third vertex of quadrangle. - * \param v3 pointer toward the fourth vertex of quadrangle. - * \param ref pointer toward the quadrangle reference. - * \param isRequired pointer toward the flag saying if quadrangle is + * \param mesh pointer to the mesh structure. + * \param v0 pointer to the first vertex of quadrangle. + * \param v1 pointer to the second vertex of quadrangle. + * \param v2 pointer to the third vertex of quadrangle. + * \param v3 pointer to the fourth vertex of quadrangle. + * \param ref pointer to the quadrangle reference. + * \param isRequired pointer to the flag saying if quadrangle is * required. * \return 0 if failed, 1 otherwise. * @@ -1130,12 +1130,12 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG2D_EXPORT int MMG2D_Get_quadrilateral(MMG5_pMesh mesh, MMG5_int* v0, MMG5_int* v1, MMG5_int* v2, MMG5_int* v3,MMG5_int* ref, int* isRequired); /** - * \param mesh pointer toward the mesh structure. - * \param quadra pointer toward the table of the quadrilaterals vertices. + * \param mesh pointer to the mesh structure. + * \param quadra pointer to the table of the quadrilaterals vertices. * Vertices of the \f$i^{th}\f$ quadrangle are stored in quadra[(i-1)*4]\@4. - * \param refs pointer toward the table of the quadrlaterals references. + * \param refs pointer to the table of the quadrlaterals references. * References of the \f$i^{th}\f$ quad is stored in refs[i-1]. - * \param areRequired pointer toward the table of the flags saying if the + * \param areRequired pointer to the table of the flags saying if the * quadrilaterals are required. areRequired[i-1]=1 if the \f$i^{th}\f$ quad * is required. * \return 0 if failed, 1 otherwise. @@ -1158,12 +1158,12 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG2D_EXPORT int MMG2D_Get_quadrilaterals(MMG5_pMesh mesh, MMG5_int* quadra,MMG5_int* refs, int* areRequired); /** - * \param mesh pointer toward the mesh structure. - * \param e0 pointer toward the first extremity of the edge. - * \param e1 pointer toward the second extremity of the edge. - * \param ref pointer toward the edge reference. - * \param isRidge pointer toward the flag saying if the edge is ridge. - * \param isRequired pointer toward the flag saying if the edge is required. + * \param mesh pointer to the mesh structure. + * \param e0 pointer to the first extremity of the edge. + * \param e1 pointer to the second extremity of the edge. + * \param ref pointer to the edge reference. + * \param isRidge pointer to the flag saying if the edge is ridge. + * \param isRequired pointer to the flag saying if the edge is required. * \return 0 if failed, 1 otherwise. * * Get extremities \a e0, \a e1 and reference \a ref of next boundary edge of @@ -1184,8 +1184,8 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG2D_EXPORT int MMG2D_Get_edge(MMG5_pMesh mesh, MMG5_int* e0, MMG5_int* e1, MMG5_int* ref ,int* isRidge, int* isRequired); /** - * \param mesh pointer toward the mesh structure. - * \param edges pointer toward the array of edges. + * \param mesh pointer to the mesh structure. + * \param edges pointer to the array of edges. * Vertices of the \f$i^{th}\f$ edge are stored in edge[(i-1)*2]\@2. * \param refs edges references. refs[i-1] is the ref of the \f$i^{th}\f$ edge. * \param areRidges 1 if the edge is a ridge, 0 otherwise. @@ -1211,8 +1211,8 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM int *areRidges,int *areRequired); /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k index of the triangle for which we want to get the quality. * \return the computed quality or 0. if fail. * @@ -1229,8 +1229,8 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG2D_EXPORT double MMG2D_Get_triangleQuality(MMG5_pMesh mesh,MMG5_pSol met, MMG5_int k); /** - * \param met pointer toward the sol structure. - * \param s pointer toward the scalar solution value. + * \param met pointer to the sol structure. + * \param s pointer to the scalar solution value. * \return 0 if failed, 1 otherwise. * * Get solution \a s of next vertex of mesh. @@ -1245,7 +1245,7 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG2D_EXPORT int MMG2D_Get_scalarSol(MMG5_pSol met, double* s); /** - * \param met pointer toward the sol structure. + * \param met pointer to the sol structure. * \param s table of the scalar solutions at mesh vertices. s[i-1] is * the solution at vertex i. * \return 0 if failed, 1 otherwise. @@ -1262,7 +1262,7 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG2D_EXPORT int MMG2D_Get_scalarSols(MMG5_pSol met, double* s); /** - * \param met pointer toward the sol structure. + * \param met pointer to the sol structure. * \param vx x value of the vectorial solution. * \param vy y value of the vectorial solution. * \return 0 if failed, 1 otherwise. @@ -1279,7 +1279,7 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG2D_EXPORT int MMG2D_Get_vectorSol(MMG5_pSol met, double* vx, double* vy); /** - * \param met pointer toward the sol structure. + * \param met pointer to the sol structure. * \param sols table of the solutions at mesh vertices. sols[2*(i-1)]\@2 is * the solution at vertex i. * \return 0 if failed, 1 otherwise. @@ -1296,10 +1296,10 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG2D_EXPORT int MMG2D_Get_vectorSols(MMG5_pSol met, double* sols); /** - * \param met pointer toward the sol structure. - * \param m11 pointer toward the position (1,1) in the solution tensor. - * \param m12 pointer toward the position (1,2) in the solution tensor. - * \param m22 pointer toward the position (2,2) in the solution tensor. + * \param met pointer to the sol structure. + * \param m11 pointer to the position (1,1) in the solution tensor. + * \param m12 pointer to the position (1,2) in the solution tensor. + * \param m22 pointer to the position (2,2) in the solution tensor. * \return 0 if failed, 1 otherwise. * * Get tensorial solution of next vertex of mesh. @@ -1314,7 +1314,7 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG2D_EXPORT int MMG2D_Get_tensorSol(MMG5_pSol met, double *m11,double *m12,double *m22); /** - * \param met pointer toward the sol structure. + * \param met pointer to the sol structure. * \param sols table of the solutions at mesh vertices. * sols[3*(i-1)]\@3 is the solution at vertex i. * \return 0 if failed, 1 otherwise. @@ -1331,7 +1331,7 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG2D_EXPORT int MMG2D_Get_tensorSols(MMG5_pSol met, double *sols); /** - * \param sol pointer toward the array of solutions + * \param sol pointer to the array of solutions * \param i position of the solution field that we want to set. * \param s solution(s) at mesh vertex \a pos. * \param pos index of the vertex on which we get the solution. @@ -1353,7 +1353,7 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG2D_EXPORT int MMG2D_Get_ithSol_inSolsAtVertices(MMG5_pSol sol,int i, double* s,MMG5_int pos); /** - * \param sol pointer toward the array of solutions + * \param sol pointer to the array of solutions * \param i position of the solution field that we want to get. * \param s table of the solutions at mesh vertices. The solution at vertex \a k * is given by s[k-1] for a scalar sol, s[2*(k-1)]\@2 for a vectorial solution @@ -1377,8 +1377,8 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the sol structure. * \return 0 if failed, 1 otherwise. * * Check if the number of given entities match with mesh and sol size @@ -1394,8 +1394,8 @@ LIBMMG2D_EXPORT int MMG2D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG2D_EXPORT int MMG2D_Chk_meshData(MMG5_pMesh mesh,MMG5_pSol met); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward an array of solution structure (that stores solution fields). + * \param mesh pointer to the mesh structure. + * \param sol pointer to an array of solution structure (that stores solution fields). * \return 1 * * Deallocation of an array of solution fields @@ -1514,7 +1514,7 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); LIBMMG2D_EXPORT int MMG2D_Free_names(const int starter,...); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param filename name of the readed file. * * \return 0 if file is not found, -1 if fail for another reason (mem lack, file @@ -1534,9 +1534,9 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); LIBMMG2D_EXPORT int MMG2D_loadMesh(MMG5_pMesh mesh,const char * filename); /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure or the NULL pointer. - * \param sol pointer toward the level-set structure or the NULL pointer. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure or the NULL pointer. + * \param sol pointer to the level-set structure or the NULL pointer. * \param filename name of file. * * \return 0 if file is not found, -1 if fail for another reason (mem lack, file @@ -1556,8 +1556,8 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); */ LIBMMG2D_EXPORT int MMG2D_loadVtpMesh(MMG5_pMesh mesh,MMG5_pSol met,MMG5_pSol sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solution structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solution structure. * \param filename name of file. * * \return 0 if file is not found, -1 if fail for another reason (mem lack, file @@ -1578,9 +1578,9 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); LIBMMG2D_EXPORT int MMG2D_loadVtpMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure or the NULL pointer. - * \param sol pointer toward the level-set structure or the NULL pointer. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure or the NULL pointer. + * \param sol pointer to the level-set structure or the NULL pointer. * \param filename name of file. * * \return 0 if file is not found, -1 if fail for another reason (mem lack, file @@ -1601,8 +1601,8 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); LIBMMG2D_EXPORT int MMG2D_loadVtuMesh(MMG5_pMesh mesh,MMG5_pSol met,MMG5_pSol sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solution structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solution structure. * \param filename name of file. * * \return 0 if file is not found, -1 if fail for another reason (mem lack, file @@ -1623,9 +1623,9 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); LIBMMG2D_EXPORT int MMG2D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure or the NULL pointer. - * \param sol pointer toward the level-set structure or the NULL pointer. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure or the NULL pointer. + * \param sol pointer to the level-set structure or the NULL pointer. * \param filename name of file. * * \return 0 if file is not found, -1 if fail for another reason (mem lack, file @@ -1646,8 +1646,8 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); LIBMMG2D_EXPORT int MMG2D_loadVtkMesh(MMG5_pMesh mesh,MMG5_pSol met,MMG5_pSol sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solution structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solution structure. * \param filename name of file. * * \return 0 if file is not found, -1 if fail for another reason (mem lack, file @@ -1668,8 +1668,8 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); LIBMMG2D_EXPORT int MMG2D_loadVtkMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solution structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solution structure. * \param filename name of file. * * \return 0 if file is not found, -1 if fail for another reason (mem lack, file @@ -1690,8 +1690,8 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); LIBMMG2D_EXPORT int MMG2D_loadMshMesh(MMG5_pMesh mesh,MMG5_pSol sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward a list of solution structures. + * \param mesh pointer to the mesh structure. + * \param sol pointer to a list of solution structures. * \param filename name of file. * * \return 0 if file is not found, -1 if fail for another reason (mem lack, file @@ -1712,8 +1712,8 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); LIBMMG2D_EXPORT int MMG2D_loadMshMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solution structure.. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solution structure.. * \param filename name of the solution file. * * \return 0 if file is not found, -1 if fail for another reason (mem lack, file @@ -1734,9 +1734,9 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); LIBMMG2D_EXPORT int MMG2D_loadSol(MMG5_pMesh mesh,MMG5_pSol sol,const char * filename); /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure or the NULL pointer. - * \param sol pointer toward the level-set structure or the NULL pointer. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure or the NULL pointer. + * \param sol pointer to the level-set structure or the NULL pointer. * \param filename name of file. * * \return 0 if file is not found, -1 if fail for another reason (mem lack, file @@ -1756,8 +1756,8 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); LIBMMG2D_EXPORT int MMG2D_loadGenericMesh(MMG5_pMesh mesh,MMG5_pSol met,MMG5_pSol sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solutions array + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solutions array * \param filename name of file. * * \return 0 if file is not found, -1 if fail for another reason (mem lack, file @@ -1779,7 +1779,7 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); LIBMMG2D_EXPORT int MMG2D_loadVect(MMG5_pMesh ,char *); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param filename name of the readed file. * \return 0 or -1 if fail, 1 otherwise. * @@ -1796,8 +1796,8 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); */ LIBMMG2D_EXPORT int MMG2D_saveMesh(MMG5_pMesh ,const char *); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solution structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solution structure. * \param filename name of file. * \return 0 if failed, 1 otherwise. * @@ -1815,8 +1815,8 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); */ LIBMMG2D_EXPORT int MMG2D_saveMshMesh(MMG5_pMesh mesh,MMG5_pSol sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solution structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solution structure. * \param filename name of file. * \return 0 if failed, 1 otherwise. * @@ -1834,8 +1834,8 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); */ LIBMMG2D_EXPORT int MMG2D_saveMshMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solution structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solution structure. * \param filename name of file. * \return 0 if failed, 1 otherwise. * @@ -1852,8 +1852,8 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); */ LIBMMG2D_EXPORT int MMG2D_saveVtkMesh(MMG5_pMesh mesh,MMG5_pSol sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solution structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solution structure. * \param filename name of file. * \return 0 if failed, 1 otherwise. * @@ -1870,8 +1870,8 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); */ LIBMMG2D_EXPORT int MMG2D_saveVtkMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solution structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solution structure. * \param filename name of file. * \return 0 if failed, 1 otherwise. * @@ -1888,8 +1888,8 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); */ LIBMMG2D_EXPORT int MMG2D_saveVtuMesh(MMG5_pMesh mesh,MMG5_pSol sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solution structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solution structure. * \param filename name of file. * \return 0 if failed, 1 otherwise. * @@ -1906,8 +1906,8 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); */ LIBMMG2D_EXPORT int MMG2D_saveVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solution structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solution structure. * \param filename name of file. * \return 0 if failed, 1 otherwise. * @@ -1924,8 +1924,8 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); */ LIBMMG2D_EXPORT int MMG2D_saveVtpMesh(MMG5_pMesh mesh,MMG5_pSol sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solution structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solution structure. * \param filename name of file. * \return 0 if failed, 1 otherwise. * @@ -1943,7 +1943,7 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); LIBMMG2D_EXPORT int MMG2D_saveVtpMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param filename name of the readed file. * \return 0 or -1 if fail, 1 otherwise. * @@ -1961,7 +1961,7 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); LIBMMG2D_EXPORT int MMG2D_saveTetgenMesh(MMG5_pMesh ,const char *); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param filename name of file. * \return 0 if failed, 1 otherwise. * @@ -1979,8 +1979,8 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); LIBMMG2D_EXPORT int MMG2D_saveGenericMesh(MMG5_pMesh mesh,MMG5_pSol sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solution structure.. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solution structure.. * \param filename name of the solution file. * \return 0 or -1 if fail, 1 otherwise. * @@ -1997,8 +1997,8 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); */ LIBMMG2D_EXPORT int MMG2D_saveSol(MMG5_pMesh mesh,MMG5_pSol sol ,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solutions array + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solutions array * \param filename name of the solution file. * \return 0 or -1 if fail, 1 otherwise. * @@ -2019,8 +2019,8 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); LIBMMG2D_EXPORT int MMG2D_saveVect(MMG5_pMesh mesh,MMG5_pSol sol,const char *filename,double lambda); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward a sol structure (metric). + * \param mesh pointer to the mesh structure. + * \param sol pointer to a sol structure (metric). * \return \ref MMG5_SUCCESS if success, \ref MMG5_LOWFAILURE if failed * but a conform mesh is saved and \ref MMG5_STRONGFAILURE if failed and we * can't save the mesh. @@ -2037,8 +2037,8 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); LIBMMG2D_EXPORT int MMG2D_mmg2dlib(MMG5_pMesh mesh,MMG5_pSol sol); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward a sol structure (metric). + * \param mesh pointer to the mesh structure. + * \param sol pointer to a sol structure (metric). * \return \ref MMG5_SUCCESS if success, \ref MMG5_LOWFAILURE if failed * but a conform mesh is saved and \ref MMG5_STRONGFAILURE if failed and we * can't save the mesh. @@ -2055,9 +2055,9 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); LIBMMG2D_EXPORT int MMG2D_mmg2dmesh(MMG5_pMesh mesh,MMG5_pSol sol); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward a sol structure (level-set). - * \param met pointer toward a sol structure (metric). + * \param mesh pointer to the mesh structure. + * \param sol pointer to a sol structure (level-set). + * \param met pointer to a sol structure (metric). * \return \ref MMG5_SUCCESS if success, \ref MMG5_LOWFAILURE if failed * but a conform mesh is saved and \ref MMG5_STRONGFAILURE if failed and we * can't save the mesh. @@ -2075,9 +2075,9 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); */ LIBMMG2D_EXPORT int MMG2D_mmg2dls(MMG5_pMesh mesh,MMG5_pSol sol,MMG5_pSol met) ; /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward a sol structure (displacement). - * \param disp pointer toward a sol (displacement for the lagrangian motion + * \param mesh pointer to the mesh structure. + * \param sol pointer to a sol structure (displacement). + * \param disp pointer to a sol (displacement for the lagrangian motion * mode) structure. * \return \ref MMG5_SUCCESS if success, \ref MMG5_LOWFAILURE if failed * but a conform mesh is saved and \ref MMG5_STRONGFAILURE if failed and we @@ -2097,7 +2097,7 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); /* Tools for the library */ /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \return 0 if fail, 1 if success. * * Print the default parameters values. @@ -2114,9 +2114,9 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); /** * \param argc number of command line arguments. * \param argv command line arguments. - * \param mesh pointer toward the mesh structure. - * \param met pointer toward a metric - * \param sol pointer toward a level-set or displacement + * \param mesh pointer to the mesh structure. + * \param met pointer to a metric + * \param sol pointer to a level-set or displacement * \return 1 if we want to run Mmg after, 0 if not or if fail. * * Store command line arguments. @@ -2127,8 +2127,8 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); LIBMMG2D_EXPORT int MMG2D_parsar(int argc,char *argv[],MMG5_pMesh mesh,MMG5_pSol met,MMG5_pSol sol); /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the sol structure. * \return 1. * * Read local parameters file. This file must have the same name as @@ -2145,7 +2145,7 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); LIBMMG2D_EXPORT int MMG2D_parsop(MMG5_pMesh mesh,MMG5_pSol met); /** - * \param prog pointer toward the program name. + * \param prog pointer to the program name. * \param return 1 if success, 0 if fail. * * Print help for mmg2d options. @@ -2161,8 +2161,8 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); LIBMMG2D_EXPORT int MMG2D_usage(char *prog); /** - * \param mesh pointer toward the mesh structure - * \param met pointer toward the sol structure + * \param mesh pointer to the mesh structure + * \param met pointer to the sol structure * \return 1 if success * * Compute unit tensor according to the lengths of the @@ -2178,8 +2178,8 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); LIBMMG2D_EXPORT extern int (*MMG2D_doSol)(MMG5_pMesh mesh ,MMG5_pSol met ); /** - * \param mesh pointer toward the mesh structure - * \param met pointer toward the sol structure + * \param mesh pointer to the mesh structure + * \param met pointer to the sol structure * \return 1 if success * * Compute constant size map according to mesh->info.hsiz, mesh->info.hmin and @@ -2195,8 +2195,8 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); LIBMMG2D_EXPORT int MMG2D_Set_constantSize(MMG5_pMesh mesh,MMG5_pSol met); /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward a sol structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to a sol structure. * * Set function pointers for length, caltri... depending if case is iso or aniso * @@ -2209,8 +2209,8 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); LIBMMG2D_EXPORT void MMG2D_setfunc(MMG5_pMesh mesh,MMG5_pSol met); /** - * \param mesh pointer toward the mesh structure. - * \param nb_edges pointer toward the number of non boundary edges. + * \param mesh pointer to the mesh structure. + * \param nb_edges pointer to the number of non boundary edges. * \return 0 if failed, 1 otherwise. * * Get the number of non boundary edges (for DG methods for example). An edge is @@ -2233,10 +2233,10 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); LIBMMG2D_EXPORT int MMG2D_Get_numberOfNonBdyEdges(MMG5_pMesh mesh, MMG5_int* nb_edges); /** - * \param mesh pointer toward the mesh structure. - * \param e0 pointer toward the first extremity of the edge. - * \param e1 pointer toward the second extremity of the edge. - * \param ref pointer toward the edge reference. + * \param mesh pointer to the mesh structure. + * \param e0 pointer to the first extremity of the edge. + * \param e1 pointer to the second extremity of the edge. + * \param ref pointer to the edge reference. * \param idx index of the non boundary edge to get (between 1 and nb_edges) * \return 0 if failed, 1 otherwise. * @@ -2259,9 +2259,9 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); /** * \brief Return adjacent elements of a triangle. - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param kel triangle index. - * \param listri pointer toward the table of the indices of the three adjacent + * \param listri pointer to the table of the indices of the three adjacent * triangles of the elt \a kel (the index is 0 if there is no adjacent). * \return 1. * @@ -2282,9 +2282,9 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); /** * \brief Return adjacent elements of a triangle. - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param ip vertex index. - * \param lispoi pointer toward an array of size MMG2D_LMAX that will contain + * \param lispoi pointer to an array of size MMG2D_LMAX that will contain * the indices of adjacent vertices to the vertex \a ip. * \return nbpoi the number of adjacent points if success, 0 if fail. * @@ -2304,10 +2304,10 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); /** * \brief Return adjacent elements of a triangle. - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param ip vertex index. * \param start index of a triangle holding \a ip. - * \param lispoi pointer toward an array of size MMG2D_LMAX that will contain + * \param lispoi pointer to an array of size MMG2D_LMAX that will contain * the indices of adjacent vertices to the vertex \a ip. * \return nbpoi the number of adjacent points if success, 0 if fail. * @@ -2326,10 +2326,10 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); LIBMMG2D_EXPORT MMG5_int MMG2D_Get_adjaVerticesFast(MMG5_pMesh mesh, MMG5_int ip,MMG5_int start, MMG5_int lispoi[MMG2D_LMAX]); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param ked index of the boundary edge. - * \param ktri pointer toward the index of the tri (filled by the function). - * \param ied pointer toward the index of the edge of the triangle \a ktri that + * \param ktri pointer to the index of the tri (filled by the function). + * \param ied pointer to the index of the edge of the triangle \a ktri that * correspond to the boundary edge \a ked. * \return 0 if fail, 1 otherwise * @@ -2348,11 +2348,11 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); */ LIBMMG2D_EXPORT int MMG2D_Get_triFromEdge(MMG5_pMesh mesh, MMG5_int ked, MMG5_int *ktri, int *ied); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param ked index of the boundary edge. - * \param ktri pointer toward an array of size 2 to fill by the indices of the + * \param ktri pointer to an array of size 2 to fill by the indices of the * triangles that share the edge \a ked (filled by the function). - * \param ied pointer toward an array of size two to fill by the indices of the + * \param ied pointer to an array of size two to fill by the indices of the * edge in each triangle. * * \return 0 if fail, 1 otherwise @@ -2398,7 +2398,7 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); /** - * \param mesh pointer toward the mesh structure + * \param mesh pointer to the mesh structure * * Reset the vertices tag (be careful all the tags are deleted). * @@ -2411,7 +2411,7 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); LIBMMG2D_EXPORT void MMG2D_Reset_verticestags(MMG5_pMesh mesh); /** - * \param mesh pointer toward the mesh structure + * \param mesh pointer to the mesh structure * * Free the mesh elements (and the adjacency). * @@ -2424,7 +2424,7 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); LIBMMG2D_EXPORT void MMG2D_Free_triangles(MMG5_pMesh mesh); /** - * \param mesh pointer toward the mesh structure + * \param mesh pointer to the mesh structure * * Free the mesh edges (and the associated xpoints). * @@ -2437,8 +2437,8 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); LIBMMG2D_EXPORT void MMG2D_Free_edges(MMG5_pMesh mesh); /** - * \param mesh pointer toward the mesh structure - * \param sol pointer toward the solution structure + * \param mesh pointer to the mesh structure + * \param sol pointer to the solution structure * * Free the solution. * @@ -2458,9 +2458,9 @@ LIBMMG2D_EXPORT int MMG2D_Free_all(const int starter,...); LIBMMG2D_EXPORT void MMG2D_Set_commonFunc(void); /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param ls pointer toward a solution structure (level-set or displacement). + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param ls pointer to a solution structure (level-set or displacement). * * \return 1 if success, 0 if fail (computed bounding box too small * or one af the anisotropic input metric is not valid). diff --git a/src/mmg2d/libmmg2d_tools.c b/src/mmg2d/libmmg2d_tools.c index 644ff00d8..0ebf7e9ab 100644 --- a/src/mmg2d/libmmg2d_tools.c +++ b/src/mmg2d/libmmg2d_tools.c @@ -521,7 +521,7 @@ int MMG2D_parsar(int argc,char *argv[],MMG5_pMesh mesh,MMG5_pSol met,MMG5_pSol s } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \return 0 if fail, 1 if success. * * Print the default parameters values. @@ -537,8 +537,8 @@ int MMG2D_defaultValues(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh - * \param met pointer toward the metric + * \param mesh pointer to the mesh + * \param met pointer to the metric * * \return 1 if success, 0 if fail * diff --git a/src/mmg2d/lissmet_2d.c b/src/mmg2d/lissmet_2d.c index e4363ac3d..06212d352 100644 --- a/src/mmg2d/lissmet_2d.c +++ b/src/mmg2d/lissmet_2d.c @@ -34,8 +34,8 @@ #include "libmmg2d_private.h" /** - * \param mesh pointer toward the mesh - * \param sol pointer toward the metric + * \param mesh pointer to the mesh + * \param sol pointer to the metric * * \return 0 if fail, 1 if success * diff --git a/src/mmg2d/locate_2d.c b/src/mmg2d/locate_2d.c index 4d4acef8e..3b95a91ed 100644 --- a/src/mmg2d/locate_2d.c +++ b/src/mmg2d/locate_2d.c @@ -212,7 +212,7 @@ int MMG2D_cutEdgeTriangle(MMG5_pMesh mesh,MMG5_int k,MMG5_int ia,MMG5_int ib) { } /** - * \param mesh pointer toward mesh + * \param mesh pointer to mesh * \param ip point index * \return index of one elt containing k or 0 (if no elt is found) * @@ -312,11 +312,11 @@ MMG5_int MMG2D_findTria(MMG5_pMesh mesh,MMG5_int ip) { } /** - * \param mesh pointer toward the mesh + * \param mesh pointer to the mesh * \param ia index of first extremity of the edge * \param ib index of second extremity of the edge - * \param kdep pointer toward the index of the first element intersecting the edge - * \param list pointer toward the list of elts intersected by the edge + * \param kdep pointer to the index of the first element intersecting the edge + * \param list pointer to the list of elts intersected by the edge * * \return 4 if the edge exist in the mesh, 0 if fail, ??? otherwise * diff --git a/src/mmg2d/mmg2d.c b/src/mmg2d/mmg2d.c index 68518d094..65f8c7d89 100644 --- a/src/mmg2d/mmg2d.c +++ b/src/mmg2d/mmg2d.c @@ -38,8 +38,8 @@ static void MMG5_endcod(void) { } /** - * \param mesh pointer toward the mesh structure. - * \param bdyRefs pointer toward the list of the boundary references. + * \param mesh pointer to the mesh structure. + * \param bdyRefs pointer to the list of the boundary references. * \return npar, the number of local parameters at edges if success, * 0 otherwise. * @@ -84,9 +84,9 @@ int MMG2D_countLocalParamAtEdg( MMG5_pMesh mesh,MMG5_iNode **bdyRefs) { } /** - * \param mesh pointer toward the mesh structure. - * \param bdryRefs pointer toward the list of the boundary references. - * \param out pointer toward the file in which to write. + * \param mesh pointer to the mesh structure. + * \param bdryRefs pointer to the list of the boundary references. + * \param out pointer to the file in which to write. * \return 1 if success, 0 otherwise. * * Write the local default values at edges in the parameter file. @@ -110,7 +110,7 @@ int MMG2D_writeLocalParamAtEdg( MMG5_pMesh mesh, MMG5_iNode *bdryRefs, } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \return 1 if success, 0 otherwise. * * Write a DEFAULT.mmg2d file containing the default values of parameters that @@ -172,9 +172,9 @@ int MMG2D_writeLocalParam( MMG5_pMesh mesh ) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward a sol structure (metric). - * \param sol pointer toward a sol structure (metric). + * \param mesh pointer to the mesh structure. + * \param met pointer to a sol structure (metric). + * \param sol pointer to a sol structure (metric). * * \return \ref MMG5_SUCCESS if success, \ref MMG5_LOWFAILURE if failed * but a conform mesh is saved and \ref MMG5_STRONGFAILURE if failed and we diff --git a/src/mmg2d/mmg2d1.c b/src/mmg2d/mmg2d1.c index 691376960..3f1c7dd38 100644 --- a/src/mmg2d/mmg2d1.c +++ b/src/mmg2d/mmg2d1.c @@ -348,10 +348,10 @@ MMG5_int MMG2D_anaelt(MMG5_pMesh mesh,MMG5_pSol met,int typchk) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k element index. - * \param vx pointer toward table of edges to split. + * \param vx pointer to table of edges to split. * \return 1. * * Find acceptable position for splitting. @@ -628,8 +628,8 @@ int MMG2D_adptri(MMG5_pMesh mesh,MMG5_pSol met) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * * \return -1 if failed or number of new points. * @@ -809,8 +809,8 @@ MMG5_int MMG2D_movtri(MMG5_pMesh mesh,MMG5_pSol met,int maxit,int8_t improve) { } /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure. * \return 1 if success, 0 if strongly fail. * * Mesh adaptation -- new version of mmg2d1.c diff --git a/src/mmg2d/mmg2d2.c b/src/mmg2d/mmg2d2.c index 06db52efb..ff211adcc 100644 --- a/src/mmg2d/mmg2d2.c +++ b/src/mmg2d/mmg2d2.c @@ -34,7 +34,7 @@ #include "mmgexterns_private.h" /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \return 1 if success, 0 if fail. * * Remove the bounding box triangles. @@ -155,7 +155,7 @@ MMG5_int MMG2D_findtrianglestate(MMG5_pMesh mesh,MMG5_int k,MMG5_int ip1,MMG5_in } /** - * \param mesh pointer toward mesh + * \param mesh pointer to mesh * \param k point index * \return index of one elt containing k or 0 (if no elt is found) * @@ -196,8 +196,8 @@ MMG5_int MMG2D_findTria_exhaust(MMG5_pMesh mesh,MMG5_int k) { /** - * \param mesh pointer toward the mesh structure - * \param sol pointer toward the solution structure + * \param mesh pointer to the mesh structure + * \param sol pointer to the solution structure * \return 0 if fail. * * Insertion of the list of points inside the mesh @@ -310,7 +310,7 @@ int MMG2D_insertpointdelone(MMG5_pMesh mesh,MMG5_pSol sol) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * * \return 0 if fail, 1 if success. * @@ -497,8 +497,8 @@ int MMG2D_markSD(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure. * \return 0 if fail, 1 if success. * * Mesh triangulation. diff --git a/src/mmg2d/mmg2d6.c b/src/mmg2d/mmg2d6.c index 2dd7d938a..23e32bb4c 100644 --- a/src/mmg2d/mmg2d6.c +++ b/src/mmg2d/mmg2d6.c @@ -35,9 +35,9 @@ #include "mmg2dexterns_private.h" /** - * \param mesh pointer toward the mesh - * \param sol pointer toward the level-set - * \param met pointer toward a metric (non-mandatory) + * \param mesh pointer to the mesh + * \param sol pointer to the level-set + * \param met pointer to a metric (non-mandatory) * * \return 1 if success, 0 otherwise * diff --git a/src/mmg2d/mmg2d9.c b/src/mmg2d/mmg2d9.c index ff52df89f..62d2e7dba 100644 --- a/src/mmg2d/mmg2d9.c +++ b/src/mmg2d/mmg2d9.c @@ -71,8 +71,8 @@ double MMG2D_estavglen(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh structure - * \param disp pointer toward the displacement structure. + * \param mesh pointer to the mesh structure + * \param disp pointer to the displacement structure. * \param t fraction of displacement to test * \param tetIdx to fill with the list of non valid tria if provided. * @@ -176,9 +176,9 @@ int MMG2D_dispmesh(MMG5_pMesh mesh,MMG5_pSol disp,short t,int itdeg) { } /** - * \param mesh pointer toward the mesh structure. - * \param disp pointer toward the displacement structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param disp pointer to the displacement structure. + * \param met pointer to the metric structure. * \param itdeg degraded elements. * \param *warn \a warn is set to 1 if not enough memory is available to complete mesh. * \return -1 if failed. @@ -274,8 +274,8 @@ MMG5_int MMG2D_spllag(MMG5_pMesh mesh,MMG5_pSol disp,MMG5_pSol met,MMG5_int itde } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param itdeg degraded elements. * \return -1 if failed. * \return number of collapsed points. @@ -339,8 +339,8 @@ static int MMG2D_coleltlag(MMG5_pMesh mesh,MMG5_pSol met,int itdeg) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param crit coefficient of quality improvment. * \param itdeg degraded elements. * @@ -383,8 +383,8 @@ MMG5_int MMG2D_swpmshlag(MMG5_pMesh mesh,MMG5_pSol met,double crit,int itdeg) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param itdeg degraded elements. * \return -1 if failed, number of moved points otherwise. * diff --git a/src/mmg2d/movpt_2d.c b/src/mmg2d/movpt_2d.c index 1aca97baa..6d691c707 100644 --- a/src/mmg2d/movpt_2d.c +++ b/src/mmg2d/movpt_2d.c @@ -37,9 +37,9 @@ //extern int8_t ddb; /** - * \param mesh pointer toward the mesh - * \param met pointer toward the metric structure. - * \param list pointer toward the ball of the point. + * \param mesh pointer to the mesh + * \param met pointer to the metric structure. + * \param list pointer to the ball of the point. * \param ilist size of the ball. * \param improve force the new minimum element quality to be greater or equal * than 0.9 of the old minimum element quality. @@ -198,9 +198,9 @@ int MMG2D_movedgpt(MMG5_pMesh mesh,MMG5_pSol met,int ilist,MMG5_int *list, int8_ } /** - * \param mesh pointer toward the mesh - * \param met pointer toward the metric structure. - * \param list pointer toward the ball of the point. + * \param mesh pointer to the mesh + * \param met pointer to the metric structure. + * \param list pointer to the ball of the point. * \param ilist size of the ball. * \param improve force the new minimum element quality to be greater or equal * than 0.9 of the old minimum element quality. diff --git a/src/mmg2d/quality_2d.c b/src/mmg2d/quality_2d.c index b5c493731..f2a72f623 100644 --- a/src/mmg2d/quality_2d.c +++ b/src/mmg2d/quality_2d.c @@ -35,8 +35,8 @@ #include "mmg2dexterns_private.h" /** - * \param mesh pointer toward the mesh - * \param pt pointer toward the tria + * \param mesh pointer to the mesh + * \param pt pointer to the tria * * \return the oriented area of the triangle. * @@ -95,9 +95,9 @@ double MMG2D_caltri_iso_3pt(double *a,double *b,double *c) { } /** - * \param pointer toward the mesh - * \param pointer toward the metric (for compatibility with aniso interface) - * \param pt pointer toward the tria + * \param pointer to the mesh + * \param pointer to the metric (for compatibility with aniso interface) + * \param pt pointer to the tria * * \return non-normalized quality if success, 0 if triangle is null or inverted. * @@ -172,8 +172,8 @@ double MMG2D_caltri_ani(MMG5_pMesh mesh,MMG5_pSol met,MMG5_pTria pt) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * * \return 0 if the worst element has a nul quality, 1 otherwise. * diff --git a/src/mmg2d/solmap_2d.c b/src/mmg2d/solmap_2d.c index ddabb2759..91f4e9406 100644 --- a/src/mmg2d/solmap_2d.c +++ b/src/mmg2d/solmap_2d.c @@ -38,8 +38,8 @@ #include "mmgexterns_private.h" /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the solution structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the solution structure. * \param ani 1 for aniso metric, 0 for iso one. * * \return 0 if fail, 1 if succeed. @@ -86,8 +86,8 @@ int MMG2D_solTruncatureForOptim(MMG5_pMesh mesh, MMG5_pSol met, int ani) { } /** - * \param mesh pointer toward the mesh structure - * \param sol pointer toward the sol structure + * \param mesh pointer to the mesh structure + * \param sol pointer to the sol structure * \return 1 if success * * Compute isotropic size map according to the mean of the length of the edges @@ -164,8 +164,8 @@ int MMG2D_doSol_iso(MMG5_pMesh mesh,MMG5_pSol sol) { } /** - * \param mesh pointer toward the mesh structure - * \param sol pointer toward the sol structure + * \param mesh pointer to the mesh structure + * \param sol pointer to the sol structure * \return 1 if success * * Compute anisotropic unit size map using statistical concept of diff --git a/src/mmg2d/split_2d.c b/src/mmg2d/split_2d.c index 03edb2319..f87344fb0 100644 --- a/src/mmg2d/split_2d.c +++ b/src/mmg2d/split_2d.c @@ -37,8 +37,8 @@ extern uint8_t ddb; /** - * \param mesh pointer toward the mesh - * \param met pointer toward the metric + * \param mesh pointer to the mesh + * \param met pointer to the metric * \param k triangle index * \param i local index of the edge to split * @@ -230,7 +230,7 @@ MMG5_int MMG2D_chkspl(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int k,int8_t i) { } /** - * \parma mesh pointer toward the mesh + * \parma mesh pointer to the mesh * \param k index of the tria to split * \param i local index of the edge to split * \param ip global index of the new point @@ -332,8 +332,8 @@ int MMG2D_split1b(MMG5_pMesh mesh,MMG5_int k,int8_t i,MMG5_int ip) { } /** - * \param mesh pointer toward the mesh - * \param sol pointer toward the metric + * \param mesh pointer to the mesh + * \param sol pointer to the metric * \param k triangle index * \param vx list of new point indices for each edge * @@ -377,8 +377,8 @@ int MMG2D_split1_sim(MMG5_pMesh mesh, MMG5_pSol sol, MMG5_int k, MMG5_int vx[3]) } /** - * \param mesh pointer toward the mesh - * \param sol pointer toward the metric + * \param mesh pointer to the mesh + * \param sol pointer to the metric * \param k triangle index * \param vx list of new point indices for each edge * @@ -443,8 +443,8 @@ int MMG2D_split1(MMG5_pMesh mesh, MMG5_pSol sol, MMG5_int k, MMG5_int vx[3]) { } /** - * \param mesh pointer toward the mesh - * \param sol pointer toward the metric + * \param mesh pointer to the mesh + * \param sol pointer to the metric * \param k triangle index * \param vx list of new point indices for each edge * @@ -492,8 +492,8 @@ int MMG2D_split2_sim(MMG5_pMesh mesh, MMG5_pSol sol, MMG5_int k, MMG5_int vx[3]) } /** - * \param mesh pointer toward the mesh - * \param sol pointer toward the metric + * \param mesh pointer to the mesh + * \param sol pointer to the metric * \param k triangle index * \param vx list of new point indices for each edge * @@ -579,8 +579,8 @@ int MMG2D_split2(MMG5_pMesh mesh, MMG5_pSol sol, MMG5_int k, MMG5_int vx[3]) { } /** - * \param mesh pointer toward the mesh - * \param sol pointer toward the metric + * \param mesh pointer to the mesh + * \param sol pointer to the metric * \param k triangle index * \param vx list of new point indices for each edge * @@ -617,8 +617,8 @@ int MMG2D_split3_sim(MMG5_pMesh mesh, MMG5_pSol sol, MMG5_int k, MMG5_int vx[3]) } /** - * \param mesh pointer toward the mesh - * \param sol pointer toward the metric + * \param mesh pointer to the mesh + * \param sol pointer to the metric * \param k triangle index * \param vx list of new point indices for each edge * @@ -709,7 +709,7 @@ int MMG2D_split3(MMG5_pMesh mesh, MMG5_pSol sol, MMG5_int k, MMG5_int vx[3]) { } /** - * \param mesh pointer toward the mesh + * \param mesh pointer to the mesh * \param k index of the tria to split * \param ip global index of the new point * diff --git a/src/mmg2d/tools_2d.c b/src/mmg2d/tools_2d.c index 286ff19a3..d399de671 100644 --- a/src/mmg2d/tools_2d.c +++ b/src/mmg2d/tools_2d.c @@ -34,7 +34,7 @@ #include "libmmg2d_private.h" /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param kel index of the element in the unpacked mesh * * @@ -59,7 +59,7 @@ MMG5_int MMG2D_indElt(MMG5_pMesh mesh, MMG5_int kel) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param kp index of the point in the unpacked mesh * * \return 0 if fail, index of the point in packed numerotation otherwise. @@ -83,7 +83,7 @@ MMG5_int MMG2D_indPt(MMG5_pMesh mesh, MMG5_int kp) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param nsd index of subdomain to keep. * * Keep only subdomain of index \a nsd and remove other subdomains. diff --git a/src/mmg2d/variadic_2d.c b/src/mmg2d/variadic_2d.c index 3d6eabc76..8053ec901 100644 --- a/src/mmg2d/variadic_2d.c +++ b/src/mmg2d/variadic_2d.c @@ -42,10 +42,10 @@ #include "mmg2dexterns_private.h" /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure. - * \param ls pointer toward the level-set (in ls-mode). - * \param disp pointer toward the displacement (in lag mode). + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure. + * \param ls pointer to the level-set (in ls-mode). + * \param disp pointer to the displacement (in lag mode). * * \return 1 if success, 0 if fail * @@ -83,10 +83,10 @@ int MMG2D_Alloc_mesh(MMG5_pMesh *mesh, MMG5_pSol *met, MMG5_pSol *ls, return 1; } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward a sol structure (metric). - * \param ls pointer toward a sol structure (level-set). - * \param disp pointer toward a sol structure (displacement). + * \param mesh pointer to the mesh structure. + * \param met pointer to a sol structure (metric). + * \param ls pointer to a sol structure (level-set). + * \param disp pointer to a sol structure (displacement). * * Initialization of mesh and solution structures to their default * values (default names, versions, dimensions...). @@ -152,11 +152,11 @@ void MMG2D_Init_woalloc_mesh(MMG5_pMesh *mesh, MMG5_pSol *met,MMG5_pSol *ls,MMG5 * structure must follow one of the \a MMG5_ARG* preprocessor variable that allow to identify * it. * - * \a argptr contains at least a pointer toward a \a MMG5_pMesh structure + * \a argptr contains at least a pointer to a \a MMG5_pMesh structure * (that will contain the mesh and identified by the MMG5_ARG_ppMesh keyword) * * To call the \a MMG2D_mmg2dlib function, you must also provide - * a pointer toward a \a MMG5_pSol structure (that will contain the ouput + * a pointer to a \a MMG5_pSol structure (that will contain the ouput * metric (and the input one, if provided) and identified by the MMG5_ARG_ppMet * keyword). * @@ -165,7 +165,7 @@ void MMG2D_Init_woalloc_mesh(MMG5_pMesh *mesh, MMG5_pSol *met,MMG5_pSol *ls,MMG5 * identified by the MMG5_ARG_ppLs keyword). * * To call the \a MMG2D_mmg2dmov library, you must also provide a - * pointer toward a \a MMG5_pSol structure storing the displacement (and + * pointer to a \a MMG5_pSol structure storing the displacement (and * identified by the MMG5_ARG_ppDisp keyword). * * \return 0 if fail, 1 otherwise @@ -232,11 +232,11 @@ int MMG2D_Init_mesh_var( va_list argptr ) { * structure must follow one of the \a MMG5_ARG preprocessor variable that allow to * identify it. * - * \a argptr contains at least a pointer toward a \a MMG5_pMesh structure + * \a argptr contains at least a pointer to a \a MMG5_pMesh structure * (that will contain the mesh and identified by the MMG5_ARG_ppMesh keyword) * * To call the \a MMG2D_mmg2dlib function, you must also provide - * a pointer toward a \a MMG5_pSol structure (that will contain the ouput + * a pointer to a \a MMG5_pSol structure (that will contain the ouput * metric (and the input one, if provided) and identified by the MMG5_ARG_ppMet * keyword). * @@ -245,7 +245,7 @@ int MMG2D_Init_mesh_var( va_list argptr ) { * identified by the MMG5_ARG_ppLs keyword). * * To call the \a MMG2D_mmg2dmov library, you must also provide a - * pointer toward a \a MMG5_pSol structure storing the displacement (and + * pointer to a \a MMG5_pSol structure storing the displacement (and * identified by the MMG5_ARG_ppDisp keyword). * * \return 0 if fail, 1 if success @@ -342,9 +342,9 @@ int MMG2D_Free_all_var(va_list argptr) /** * \param argptr list of the mmg structures that must be deallocated. Each * structure must follow one of the \a MMG5_ARG* preprocessor variable that allow - * to identify it. \a argptr contains at least a pointer toward a \a MMG5_pMesh + * to identify it. \a argptr contains at least a pointer to a \a MMG5_pMesh * structure (that will contain the mesh and identified by the MMG5_ARG_ppMesh - * keyword) and a pointer toward a \a MMG5_pSol structure (that will contain the + * keyword) and a pointer to a \a MMG5_pSol structure (that will contain the * ouput metric (and the input one, if provided) and identified by the * MMG5_ARG_ppMet keyword). * @@ -353,7 +353,7 @@ int MMG2D_Free_all_var(va_list argptr) * identified by the MMG5_ARG_ppLs keyword). * * To call the \a MMG2D_mmg2dmov library, you must also provide a - * pointer toward a \a MMG5_pSol structure storing the displacement (and + * pointer to a \a MMG5_pSol structure storing the displacement (and * identified by the MMG5_ARG_ppDisp keyword). * * \return 1 if success, 0 if fail @@ -465,9 +465,9 @@ int MMG2D_Free_structures_var(va_list argptr) /** * \param argptr list of the mmg structures for whose we want to deallocate the * name. Each structure must follow one of the \a MMG5_ARG* preprocessor variable - * that allow to identify it. \a argptr contains at least a pointer toward a \a + * that allow to identify it. \a argptr contains at least a pointer to a \a * MMG5_pMesh structure (that will contain the mesh and identified by the - * MMG5_ARG_ppMesh keyword) and a pointer toward a \a MMG5_pSol structure (that + * MMG5_ARG_ppMesh keyword) and a pointer to a \a MMG5_pSol structure (that * will contain the ouput metric (and the input one, if provided) and identified * by the MMG5_ARG_ppMet keyword). * diff --git a/src/mmg2d/zaldy_2d.c b/src/mmg2d/zaldy_2d.c index 51a8dd168..4686ca2de 100644 --- a/src/mmg2d/zaldy_2d.c +++ b/src/mmg2d/zaldy_2d.c @@ -128,7 +128,7 @@ int MMG2D_delElt(MMG5_pMesh mesh,MMG5_int iel) { } /** - * \param mesh pointer toward the mesh structure + * \param mesh pointer to the mesh structure * * \return 0 if fail, 1 otherwise * @@ -227,7 +227,7 @@ int MMG2D_memOption_memSet(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh structure + * \param mesh pointer to the mesh structure * * \return 0 if fail, 1 otherwise * @@ -246,7 +246,7 @@ int MMG2D_memOption(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * * \return 0 if failed, 1 otherwise. * @@ -297,7 +297,7 @@ int MMG2D_setMeshSize_alloc( MMG5_pMesh mesh ) { } /** - * \param mesh pointer toward the mesh structure + * \param mesh pointer to the mesh structure * * \return 0 if fail, 1 otherwise * diff --git a/src/mmg3d/API_functions_3d.c b/src/mmg3d/API_functions_3d.c index 225866382..462fe6c82 100644 --- a/src/mmg3d/API_functions_3d.c +++ b/src/mmg3d/API_functions_3d.c @@ -204,7 +204,7 @@ int MMG3D_Set_solsAtVerticesSize(MMG5_pMesh mesh, MMG5_pSol *sol,int nsols, } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param np number of vertices. * \param ne number of tetrahedra. * \param nprism number of prisms. diff --git a/src/mmg3d/PRoctree_3d.c b/src/mmg3d/PRoctree_3d.c index 6e8e97801..59505b943 100644 --- a/src/mmg3d/PRoctree_3d.c +++ b/src/mmg3d/PRoctree_3d.c @@ -40,7 +40,7 @@ #include /** - * \param q pointer toward the PROctree cell + * \param q pointer to the PROctree cell * * Initialisation of the PROctree cell. * @@ -54,8 +54,8 @@ void MMG3D_initPROctree_s( MMG3D_PROctree_s* q) } /** - * \param mesh pointer toward the mesh structure. - * \param q pointer toward the global PROctree + * \param mesh pointer to the mesh structure. + * \param q pointer to the global PROctree * \param nv maximum number of vertices in each cell before subdivision * \return 1 if ok 0 if memory saturated * @@ -103,8 +103,8 @@ int MMG3D_initPROctree(MMG5_pMesh mesh,MMG3D_pPROctree* q, int nv) } /** - * \param mesh pointer toward the mesh structure. - * \param q pointer toward the PROctree cell + * \param mesh pointer to the mesh structure. + * \param q pointer to the PROctree cell * \param nv number of vertices in the cell subtree * * Free the PROctree cell. @@ -155,8 +155,8 @@ void MMG3D_freePROctree_s(MMG5_pMesh mesh,MMG3D_PROctree_s* q, int nv) } /** - * \param mesh pointer toward the mesh structure. - * \param q pointer toward a pointer toward the global PROctree. + * \param mesh pointer to the mesh structure. + * \param q pointer to a pointer to the global PROctree. * * Free the global PROctree structure. * @@ -172,7 +172,7 @@ void MMG3D_freePROctree(MMG5_pMesh mesh,MMG3D_pPROctree *q) /** - * \param q pointer toward the global PROctree. + * \param q pointer to the global PROctree. * \param ver coordinates of the point. * \param dim space dimension (should be 3). * \return the integer containing the coordinates @@ -209,8 +209,8 @@ int64_t MMG3D_getPROctreeCoordinate(MMG3D_pPROctree q, double* ver, int dim) /** - * \param mesh pointer toward the mesh structure. - * \param q pointer toward the global PROctree. + * \param mesh pointer to the mesh structure. + * \param q pointer to the global PROctree. * \param no index of the moved point. * \param newVer new coordinates for the moved point. * \param oldVer old coordinates for the moved point. @@ -417,14 +417,14 @@ int MMG3D_intersectRect(double *rectin, double *rectinout) } /** - * \param q pointer toward the PROctree cell. + * \param q pointer to the PROctree cell. * \param center coordinates of the centre of the current subtree. * \param rect rectangle that we want to intersect with the subtree. We define * it given: the coordinates of one corner of the rectange and the length of * the rectangle in each dimension. - * \param qlist pointer toward the list of pointer over the sub PROctrees that + * \param qlist pointer to the list of pointer over the sub PROctrees that * intersect \a rect. - * \param dist pointer toward the list of distances between center of + * \param dist pointer to the list of distances between center of * the PROctree cells in qlist and the last 3 elements are the coordinates * of the center of the whole recangle. * \param ani metric of the point. @@ -556,13 +556,13 @@ int MMG3D_getListSquareRec(MMG3D_PROctree_s* q, double* center, double* rect, } /** - * \param mesh pointer toward the mesh structure + * \param mesh pointer to the mesh structure * \param ani metric to use for the cell ordering from closest to farthest - * \param q pointer toward the global PROctree structure. + * \param q pointer to the global PROctree structure. * \param rect rectangle that we want to intersect with the subtree. We define * it given: the coordinates of one corner of the rectangle and the length of * the rectangle in each dimension. - * \param qlist pointer toward the list of pointer over the sub PROctrees that + * \param qlist pointer to the list of pointer over the sub PROctrees that * intersect \a rect. * * \return index, the number of subtrees in the list @@ -635,8 +635,8 @@ int MMG3D_getListSquare(MMG5_pMesh mesh, double* ani, MMG3D_pPROctree q, double* } /** - * \param mesh pointer toward the mesh structure. - * \param q pointer toward an PROctree cell. + * \param mesh pointer to the mesh structure. + * \param q pointer to an PROctree cell. * \param ver vertex coordinates scaled such that the quadrant is [0;1]x[0;1]x[0;1] * \param no vertex index in the mesh. * \param nv maximum number of points in an PROctree cell. @@ -765,8 +765,8 @@ int MMG3D_addPROctreeRec(MMG5_pMesh mesh, MMG3D_PROctree_s* q, double* ver, } /** - * \param pointer toward the mesh structure - * \param q pointer toward the global PROctree structure + * \param pointer to the mesh structure + * \param q pointer to the global PROctree structure * \param no index of the point to add to the PROctree * * Add the vertex of index \a no to the PROctree. @@ -789,7 +789,7 @@ int MMG3D_addPROctree(MMG5_pMesh mesh, MMG3D_pPROctree q, const MMG5_int no) } /** - * \param q pointer toward a terminal PROctree cell (containing vertex) + * \param q pointer to a terminal PROctree cell (containing vertex) * \param no index of the point to delete from the PROctree * \return 1 if ok 0 if memory saturated * @@ -822,8 +822,8 @@ int MMG3D_delPROctreeVertex(MMG5_pMesh mesh, MMG3D_PROctree_s* q, MMG5_int indNo } /** - * \param q0 pointer toward an PROctree cell. - * \param q pointer toward an PROctree cell. + * \param q0 pointer to an PROctree cell. + * \param q pointer to an PROctree cell. * \param dim dimension of the space (=3). * \param nv maximum number of points in an PROctree cell. * \param index next index in the array to be filled. @@ -853,8 +853,8 @@ void MMG3D_mergeBranchesRec(MMG3D_PROctree_s* q0, MMG3D_PROctree_s* q, int dim, } /** - * \param mesh pointer toward the mesh structure. - * \param q pointer toward an PROctree cell. + * \param mesh pointer to the mesh structure. + * \param q pointer to an PROctree cell. * \param dim dimension of the space (=3) * \param nv maximum number of points in an PROctree cell. * @@ -880,8 +880,8 @@ void MMG3D_mergeBranches(MMG5_pMesh mesh,MMG3D_PROctree_s* q, int dim, int nv) } /** - * \param mesh pointer toward the mesh structure. - * \param q pointer toward an PROctree cell. + * \param mesh pointer to the mesh structure. + * \param q pointer to an PROctree cell. * \param ver vertex coordinates scaled such that the quadrant is [0;1]x[0;1]x[0;1] * \param no vertex index in the mesh. * \param nv maximum number of points in an PROctree cell. @@ -966,8 +966,8 @@ int MMG3D_delPROctreeRec(MMG5_pMesh mesh, MMG3D_PROctree_s* q, double* ver, cons } /** - * \param mesh pointer toward the mesh structure. - * \param q pointer toward the global PROctree. + * \param mesh pointer to the mesh structure. + * \param q pointer to the global PROctree. * \param no reference of the vertex to be deleted. * \return 1 if ok 0 if memory saturated * @@ -993,7 +993,7 @@ int MMG3D_delPROctree(MMG5_pMesh mesh, MMG3D_pPROctree q, const int no) /** - * \param q pointer toward an PROctree cell + * \param q pointer to an PROctree cell * \param depth depth of the subtree * \param nv number of vertices in the subtree * \param dim dimension in which we work @@ -1019,7 +1019,7 @@ void MMG3D_printArbreDepth(MMG3D_PROctree_s* q, int depth, int nv, int dim) } /** - * \param q pointer toward the global PROctree structure + * \param q pointer to the global PROctree structure * * Print the PROctree. * @@ -1042,7 +1042,7 @@ void MMG3D_printArbre(MMG3D_pPROctree q) } /** - * \param q pointer toward an PROctree cell + * \param q pointer to an PROctree cell * \param nv maximum number of vertices in an PROctree leaf * \param dim spacial dimension * @@ -1065,7 +1065,7 @@ void MMG3D_printSubArbre(MMG3D_PROctree_s* q, int nv, int dim) /** - * \param q pointer toward an PROctree cell + * \param q pointer to an PROctree cell * \param nv maximum number of vertices in an PROctree leaf * \param dim dimension in which we work * \param s size of the PROctree @@ -1106,7 +1106,7 @@ void MMG3D_sizeArbreRec(MMG3D_PROctree_s* q, int nv, int dim,int* s1, int* s2) } /** - * \param q pointer toward the global PROctree structure + * \param q pointer to the global PROctree structure * \param dim dimension in which we work * * \return the size of the tree or NULL pointer if fail @@ -1127,9 +1127,9 @@ int* MMG3D_sizeArbre(MMG3D_pPROctree q,int dim) } /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solution structure. - * \param PROctree pointer toward the PROctree structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solution structure. + * \param PROctree pointer to the PROctree structure. * \param ip index of point to check. * \param lmax threshold to check minimal distance between points. * @@ -1209,9 +1209,9 @@ int MMG3D_PROctreein_iso(MMG5_pMesh mesh,MMG5_pSol sol,MMG3D_pPROctree PROctree, } /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solution structure. - * \param PROctree pointer toward the PROctree structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solution structure. + * \param PROctree pointer to the PROctree structure. * \param ip index of point to check. * \param lmax threshold to check minimal distance between points. * diff --git a/src/mmg3d/PRoctree_3d_private.h b/src/mmg3d/PRoctree_3d_private.h index 085307628..8af94e88e 100644 --- a/src/mmg3d/PRoctree_3d_private.h +++ b/src/mmg3d/PRoctree_3d_private.h @@ -33,7 +33,7 @@ */ typedef struct MMG3D_PROctree_s { - struct MMG3D_PROctree_s* branches; /*!< pointer toward the subtrees of the current PROctree */ + struct MMG3D_PROctree_s* branches; /*!< pointer to the subtrees of the current PROctree */ MMG5_int* v; /*!< vertex index */ int nbVer; /*!< number of vertices in the sub tree */ int depth; /*!< sub tree depth */ diff --git a/src/mmg3d/analys_3d.c b/src/mmg3d/analys_3d.c index a28b5ffd9..c1a336b68 100644 --- a/src/mmg3d/analys_3d.c +++ b/src/mmg3d/analys_3d.c @@ -462,7 +462,7 @@ int MMG5_setdhd(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \return 1. * * check subdomains connected by a vertex and mark these vertex as CRN and REQ. @@ -616,7 +616,7 @@ int MMG5_singul(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward mesh + * \param mesh pointer to mesh * \return 1 if successful, 0 if failed * * Compute normals at C1 vertices, for C0: tangents. @@ -813,8 +813,8 @@ int MMG5_norver(MMG5_pMesh mesh) { } /** - * \param mesh pointer towards the mesh - * \param pt pointer towards current triangle + * \param mesh pointer tos the mesh + * \param pt pointer tos current triangle * \param k number of current point * \param c newly computed coordinates (giving negative area) * \param n normal of triangle before regularization @@ -881,7 +881,7 @@ static inline int MMG3D_dichotomytria(MMG5_pMesh mesh, MMG5_pTria pt, MMG5_int k } /** - * \param mesh pointer towards the mesh + * \param mesh pointer tos the mesh * \param v list of vertices of current tetrahedron * \param k number of current point * \param c input : newly computed coordinates (giving negative area), output : coordinates after dichotomy @@ -947,7 +947,7 @@ static inline int MMG3D_dichotomytetra(MMG5_pMesh mesh, MMG5_int *v, MMG5_int k, } /** - * \param mesh pointer toward a MMG5 mesh structure. + * \param mesh pointer to a MMG5 mesh structure. * \return 0 if fail, 1 otherwise. * * Regularization procedure for vertices coordinates, dual Laplacian in 3D @@ -1176,7 +1176,7 @@ int MMG3D_regver(MMG5_pMesh mesh) { /** - * \param mesh pointer toward the mesh + * \param mesh pointer to the mesh * * \return 0 if fail, 1 otherwise * @@ -1298,7 +1298,7 @@ int MMG3D_nmgeom(MMG5_pMesh mesh){ } /** - * \param mesh pointer toward mesh + * \param mesh pointer to mesh * \return 1 if successful, 0 if fail * * preprocessing stage: mesh analysis. diff --git a/src/mmg3d/anisomovpt_3d.c b/src/mmg3d/anisomovpt_3d.c index 38929ba53..d88a4b100 100644 --- a/src/mmg3d/anisomovpt_3d.c +++ b/src/mmg3d/anisomovpt_3d.c @@ -39,10 +39,10 @@ #include "mmgexterns_private.h" /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param PROctree pointer toward the PROctree structure. - * \param list pointer toward the volumic ball of the point. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param PROctree pointer to the PROctree structure. + * \param list pointer to the volumic ball of the point. * \param ilist size of the volumic ball. * \param improve force the new minimum element quality to be greater or equal * than 1.02 of the old minimum element quality. @@ -170,12 +170,12 @@ int MMG5_movintpt_ani(MMG5_pMesh mesh,MMG5_pSol met, MMG3D_pPROctree PROctree, i } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param PROctree pointer toward the PROctree structure. - * \param listv pointer toward the volumic ball of the point. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param PROctree pointer to the PROctree structure. + * \param listv pointer to the volumic ball of the point. * \param ilistv size of the volumic ball. - * \param lists pointer toward the surfacic ball of the point. + * \param lists pointer to the surfacic ball of the point. * \param ilists size of the surfacic ball. * \param improve force the new minimum element quality to be greater or equal * than 1.02 of the old minimum element quality. @@ -481,12 +481,12 @@ int MMG5_movbdyregpt_ani(MMG5_pMesh mesh, MMG5_pSol met, MMG3D_pPROctree PROctre } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param PROctree pointer toward the PROctree structure. - * \param listv pointer toward the volumic ball of the point. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param PROctree pointer to the PROctree structure. + * \param listv pointer to the volumic ball of the point. * \param ilistv size of the volumic ball. - * \param lists pointer toward the surfacic ball of the point. + * \param lists pointer to the surfacic ball of the point. * \param ilists size of the surfacic ball. * \param improve force the new minimum element quality to be greater or equal * than 1.02 of the old minimum element quality. @@ -686,12 +686,12 @@ int MMG3D_movbdycurvept_ani(MMG5_pMesh mesh, MMG5_pSol met, MMG3D_pPROctree PROc } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param PROctree pointer toward the PROctree structure. - * \param listv pointer toward the volumic ball of the point. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param PROctree pointer to the PROctree structure. + * \param listv pointer to the volumic ball of the point. * \param ilistv size of the volumic ball. - * \param lists pointer toward the surfacic ball of the point. + * \param lists pointer to the surfacic ball of the point. * \param ilists size of the surfacic ball. * \param improve force the new minimum element quality to be greater or equal * than 1.02 of the old minimum element quality. @@ -710,12 +710,12 @@ int MMG5_movbdyrefpt_ani(MMG5_pMesh mesh, MMG5_pSol met, MMG3D_pPROctree PROctre } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param PROctree pointer toward the PROctree structure. - * \param listv pointer toward the volumic ball of the point. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param PROctree pointer to the PROctree structure. + * \param listv pointer to the volumic ball of the point. * \param ilistv size of the volumic ball. - * \param lists pointer toward the surfacic ball of the point. + * \param lists pointer to the surfacic ball of the point. * \param ilists size of the surfacic ball. * \param improve force the new minimum element quality to be greater or equal * than 1.02 of the old minimum element quality. @@ -736,12 +736,12 @@ int MMG5_movbdynompt_ani(MMG5_pMesh mesh,MMG5_pSol met, MMG3D_pPROctree PROctree /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param PROctree pointer toward the PROctree structure. - * \param listv pointer toward the volumic ball of the point. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param PROctree pointer to the PROctree structure. + * \param listv pointer to the volumic ball of the point. * \param ilistv size of the volumic ball. - * \param lists pointer toward the surfacic ball of the point. + * \param lists pointer to the surfacic ball of the point. * \param ilists size of the surfacic ball. * \param improve force the new minimum element quality to be greater or equal * \return 0 if fail, 1 if success. diff --git a/src/mmg3d/anisosiz_3d.c b/src/mmg3d/anisosiz_3d.c index 8695e5eb8..cc3e0b45b 100644 --- a/src/mmg3d/anisosiz_3d.c +++ b/src/mmg3d/anisosiz_3d.c @@ -131,9 +131,9 @@ int MMG3D_chk4ridVertices(MMG5_pMesh mesh, MMG5_pTetra pt) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the sol structure. - * \param pt pointer toward a tetra. + * \param mesh pointer to the mesh structure. + * \param met pointer to the sol structure. + * \param pt pointer to a tetra. * \param m1 computed metric. * \return the number of vertices used for the mean computation, 0 if fail. * @@ -175,8 +175,8 @@ inline int MMG5_moymet(MMG5_pMesh mesh,MMG5_pSol met,MMG5_pTetra pt,double *m1) } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param kel index of the tetra in which we work. * \param iface face of the tetra on which we work. * \param ip index of the point on which we want to compute the metric @@ -371,8 +371,8 @@ static int MMG5_defmetsin(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int kel, int iface, } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param kel index of the tetra in which we work. * \param iface face of the tetra on which we work. * \param ip index of the point on which we want to compute the metric @@ -591,8 +591,8 @@ static int MMG5_defmetrid(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int kel, } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param kel index of the triangle in which we work. * \param iface face of the tetra on which we work. * \param ip index of the point on which we want to compute the metric @@ -860,8 +860,8 @@ static int MMG5_defmetref(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int kel, int iface, } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param kel index of the triangle in which we work. * \param iface working face. * \param ip index of the point on which we want to compute the metric @@ -1087,8 +1087,8 @@ static int MMG5_defmetreg(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int kel,int iface, } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param ismet 1 if user provided metric * \return 1 if success, 0 otherwise. * @@ -1251,8 +1251,8 @@ int MMG5_defmetvol(MMG5_pMesh mesh,MMG5_pSol met,int8_t ismet) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param np global index of vertex in which we intersect the metrics. * \param me physical metric at point \a np. * \return 0 if fail, 1 otherwise. @@ -1293,8 +1293,8 @@ int MMG3D_intextmet(MMG5_pMesh mesh,MMG5_pSol met,int np,double me[6]) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric stucture. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric stucture. * \return 0 if fail, 1 otherwise. * * Define size at points by intersecting the surfacic metric and the @@ -1418,8 +1418,8 @@ int MMG3D_defsiz_ani(MMG5_pMesh mesh,MMG5_pSol met) { } /** - * \param mesh pointer toward the mesh. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh. + * \param met pointer to the metric structure. * \param ip global point index. * \param ux edge vector x-component. * \param uy edge vector y-component. @@ -1484,8 +1484,8 @@ int MMG5_grad2metVol_getmet(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int ip,double ux, } /** - * \param mesh pointer toward the mesh. - * \param ppt pointer toward the P point structure. + * \param mesh pointer to the mesh. + * \param ppt pointer to the P point structure. * \param l Euclidean length of the edge PQ. * \param m metric tensor on point P. * \param mext metric tensor extended on Q. @@ -1508,8 +1508,8 @@ void MMG5_grad2metVol_extmet(MMG5_pMesh mesh,MMG5_pPoint ppt,double l,double *m, } /** - * \param mesh pointer toward the mesh. - * \param ppt pointer toward the P point structure. + * \param mesh pointer to the mesh. + * \param ppt pointer to the P point structure. * \param m metric tensor on point P. * \param mext extended metric tensor from Q to P. * \param ridgedir normal direction for metric reconstruction on P (on ridge only). @@ -1707,8 +1707,8 @@ void MMG3D_gradSimred(MMG5_pMesh mesh,MMG5_pPoint ppt,double m[6],double mext[6] } /** - * \param mesh pointer toward the mesh. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh. + * \param met pointer to the metric structure. * \param ip global index of the point. * \param m metric tensor on the point (copy). * \param ridgedir normal direction for metric reconstruction (on ridge only). @@ -1761,8 +1761,8 @@ void MMG5_grad2metVol_setmet(MMG5_pMesh mesh,MMG5_pSol met,int ip,double *m,int8 } /** - * \param mesh pointer toward the mesh. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh. + * \param met pointer to the metric structure. * \param np1 global index of the first edge extremity. * \param np2 global index of the second edge extremity. * @@ -1886,9 +1886,9 @@ int MMG3D_updatemetreq_ani(double *n,double dn[3],double vp[3][3]) { } /** - * \param mesh pointer toward the mesh. - * \param met pointer toward the metric structure. - * \param pt pointer toward a tetra. + * \param mesh pointer to the mesh. + * \param met pointer to the metric structure. + * \param pt pointer to a tetra. * \param npmaster edge extremity that cannot be modified * \param npslave edge extremity to modify to respect the gradation. * @@ -2051,8 +2051,8 @@ int MMG5_grad2metVolreq(MMG5_pMesh mesh,MMG5_pSol met,MMG5_pTetra pt,MMG5_int np /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \return 1 * * @@ -2200,8 +2200,8 @@ int MMG3D_gradsiz_ani(MMG5_pMesh mesh,MMG5_pSol met) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \return 0 if fail, 1 otherwise. * * Enforce mesh gradation by truncating size map. diff --git a/src/mmg3d/bezier_3d.c b/src/mmg3d/bezier_3d.c index 3cfebb43e..e219e5032 100644 --- a/src/mmg3d/bezier_3d.c +++ b/src/mmg3d/bezier_3d.c @@ -134,7 +134,7 @@ MMG5_BezierGeod(double c1[3],double c2[3],double t1[3],double t2[3]) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param ip0 index of the first point of the curve. * \param ip1 index of the second point of the curve. * \param b0 the first computed extrapolated control point. @@ -312,9 +312,9 @@ MMG5_BezierEdge(MMG5_pMesh mesh,MMG5_int ip0,MMG5_int ip1,double b0[3], } /** - * \param mesh pointer toward the mesh structure. - * \param pt pointer toward the triangle structure. - * \param pb pointer toward the computed Bezier structure. + * \param mesh pointer to the mesh structure. + * \param pt pointer to the triangle structure. + * \param pb pointer to the computed Bezier structure. * \param ori triangle orientation. * \return 1. * @@ -595,7 +595,7 @@ int MMG5_mmg3dBezierCP(MMG5_pMesh mesh,MMG5_Tria *pt,MMG5_pBezier pb,int8_t ori) } /** - * \param pb pointer toward the Bezier structure. + * \param pb pointer to the Bezier structure. * \param uv coordinates of the point in the parametric space. * \param o computed coordinates of the point in the real space. * \param no computed normal. diff --git a/src/mmg3d/boulep_3d.c b/src/mmg3d/boulep_3d.c index bd1c16989..da6da8ae5 100644 --- a/src/mmg3d/boulep_3d.c +++ b/src/mmg3d/boulep_3d.c @@ -39,10 +39,10 @@ extern MMG5_Info info; /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param start index of the starting tetrahedra. * \param ip local index of the point in the tetrahedra \a start. - * \param list pointer toward the list of the tetra in the volumic ball of + * \param list pointer to the list of the tetra in the volumic ball of * \a ip. * \return 0 if fail and the number of the tetra in the ball otherwise. * @@ -96,14 +96,14 @@ int MMG5_boulevolp (MMG5_pMesh mesh, MMG5_int start, int ip, int64_t * list){ } /** - * \param mesh pointer toward the mesh structure. - * \param pt pointer toward the working tetra + * \param mesh pointer to the mesh structure. + * \param pt pointer to the working tetra * \param k index of the tetra \a pt. * \param na index of the first extermity of the seeking edge. * \param nb index of the second extermity of the seeking edge. * \param error 1 if we want to print an error message, 0 for a warning. * \param mmgWarn static variable to print warning only once (not used if error==1) - * \param ia pointer toward the edge index (to fill). + * \param ia pointer to the edge index (to fill). * * \return 0 if fail, 1 if success. * @@ -181,7 +181,7 @@ void MMG3D_compute_tangent(MMG5_pMesh mesh,int nump,int ip0,int ip1,double t[3]) } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param start tetra index. * \param ip point index. * \param iface face index. @@ -326,7 +326,7 @@ int MMG5_boulenm(MMG5_pMesh mesh,MMG5_int start,int ip,int iface, } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param start tetra index. * \param ip point index. * \param t computed tangent vector. @@ -439,13 +439,13 @@ int MMG5_boulenmInt(MMG5_pMesh mesh,MMG5_int start,int ip,double t[3]) { } /** - * \param mesh pointer toward the mesh structure. - * \param hash pointer toward an allocated hash table. + * \param mesh pointer to the mesh structure. + * \param hash pointer to an allocated hash table. * \param start index of the starting tetrahedra. * \param ip local index of the point in the tetrahedra \a start. - * \param ng pointer toward the number of ridges. - * \param nr pointer toward the number of reference edges. - * \param nm pointer toward the number of non-manifold edges. + * \param ng pointer to the number of ridges. + * \param nr pointer to the number of reference edges. + * \param nm pointer to the number of non-manifold edges. * \return ns the number of special edges passing through ip, -1 if fail. * * Count the numer of ridges and reference edges incident to @@ -582,14 +582,14 @@ int MMG5_boulernm(MMG5_pMesh mesh,MMG5_Hash *hash,MMG5_int start,int ip,MMG5_int } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param start index of the starting tetra. * \param ip index in \a start of the looked point. * \param iface index in \a start of the starting face. - * \param listv pointer toward the computed volumic ball. - * \param ilistv pointer toward the computed volumic ball size. - * \param lists pointer toward the computed surfacic ball. - * \param ilists pointer toward the computed surfacic ball size. + * \param listv pointer to the computed volumic ball. + * \param ilistv pointer to the computed volumic ball size. + * \param lists pointer to the computed surfacic ball. + * \param ilists pointer to the computed surfacic ball size. * \param isnm 1 if \a ip is non-manifold, 0 otherwise. * \return -1 if fail, 1 otherwise. * @@ -744,14 +744,14 @@ int MMG5_boulesurfvolp(MMG5_pMesh mesh,MMG5_int start,int ip,int iface, } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param start index of the starting tetra. * \param ip index in \a start of the looked point. * \param iface index in \a start of the starting face. - * \param listv pointer toward the computed volumic ball. - * \param ilistv pointer toward the computed volumic ball size. - * \param lists pointer toward the computed surfacic ball. - * \param ilists pointer toward the computed surfacic ball size. + * \param listv pointer to the computed volumic ball. + * \param ilistv pointer to the computed volumic ball size. + * \param lists pointer to the computed surfacic ball. + * \param ilists pointer to the computed surfacic ball size. * \param refmin return the reference of one of the two subdomains in presence * \param refplus return the reference of the other subdomain in presence * \param isnm is the looked point \a ip non-manifold? @@ -929,15 +929,15 @@ int MMG5_boulesurfvolpNom(MMG5_pMesh mesh,MMG5_int start,int ip,int iface, /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param start index of the starting tetrahedron. * \param ip index of the looked ridge point. * \param iface index in \a start of the starting face. - * \param il1 pointer toward the first ball size. - * \param l1 pointer toward the first computed ball (associated to \a n_1's + * \param il1 pointer to the first ball size. + * \param l1 pointer to the first computed ball (associated to \a n_1's * side). - * \param il2 pointer toward the second ball size. - * \param l2 pointer toward the second computed ball (associated to \a n_2's + * \param il2 pointer to the second ball size. + * \param l2 pointer to the second computed ball (associated to \a n_2's * side). * \param ip0 index of the first extremity of the ridge. * \param ip1 index of the second extremity of the ridge. @@ -1151,7 +1151,7 @@ int MMG5_bouletrid(MMG5_pMesh mesh,MMG5_int start,int iface,int ip,int *il1,MMG5 } /** - * \param mesh pointer toward the mesh + * \param mesh pointer to the mesh * \param start tetra from which we start to travel * \param na edge vertex * \param nb edge vertex @@ -1211,7 +1211,7 @@ int MMG3D_settag_oneDir(MMG5_pMesh mesh,MMG5_int start, MMG5_int na, MMG5_int n } /** - * \param mesh pointer toward the mesh structure + * \param mesh pointer to the mesh structure * \param start tetra from which we start * \param ia local index of the edge in \a start * \param tag tag to set @@ -1274,7 +1274,7 @@ int MMG5_settag(MMG5_pMesh mesh,MMG5_int start,int ia,int16_t tag,int edg) { } /** - * \param mesh pointer toward the mesh + * \param mesh pointer to the mesh * \param start tetra from which we start to travel * \param na edge vertex * \param nb edge vertex @@ -1326,7 +1326,7 @@ int MMG3D_deltag_oneDir(MMG5_pMesh mesh,MMG5_int start, MMG5_int na, MMG5_int n } /** - * \param mesh pointer toward the mesh structure + * \param mesh pointer to the mesh structure * \param start index of the starting tetra * \param ia index of the edge in tetra \a start that we want to modify * \param tag tag to remove @@ -1382,7 +1382,7 @@ int MMG5_deltag(MMG5_pMesh mesh,MMG5_int start,int ia,int16_t tag) { } /** - * \param mesh pointer toward the mesh structure + * \param mesh pointer to the mesh structure * \param start index of the starting tetra * \param ia index of the edge * \param list list of tetra sharing the edge \a ia @@ -1537,7 +1537,7 @@ int MMG5_coquil(MMG5_pMesh mesh,MMG5_int start,int ia,int64_t*list,int8_t *isbdy } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param start starting tetra. * \param ia local edge index in tetra \a start. * @@ -1598,7 +1598,7 @@ int MMG5_srcbdy(MMG5_pMesh mesh,MMG5_int start,int ia) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param k1 should contain a tetra index. * \param k2 should contain a tetra index different from k2. * @@ -1654,21 +1654,21 @@ int MMG5_srcbdy(MMG5_pMesh mesh,MMG5_int start,int ia) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param start index of the starting tetrahedron. * \param na global index of the 1st extremity of the edge whose shell is computed * \param nb global index of the 2d extremity of the edge whose shell is computed * \param iface index of the face from which we come. * \param ia index of edge whose shell is computed (in tetra). - * \param list pointer toward the list of tetra in the shell (to fill). - * \param ilist pointer toward the number of tetra in the shell (to fill). - * \param it1 pointer toward the index of the 1st boundary face sharing \a ia - * \param it2 pointer toward the index of the 2d boundary face sharing \a ia + * \param list pointer to the list of tetra in the shell (to fill). + * \param ilist pointer to the number of tetra in the shell (to fill). + * \param it1 pointer to the index of the 1st boundary face sharing \a ia + * \param it2 pointer to the index of the 2d boundary face sharing \a ia * (to fill). - * \param adj pointer toward the adjacent to treat in the shell (to update) - * \param hasadja pointer toward 0 if we don't have adja through iface, + * \param adj pointer to the adjacent to treat in the shell (to update) + * \param hasadja pointer to 0 if we don't have adja through iface, * 1 otherwise (to fill) - * \param nbdy pointer toward the number of boundaries found minus 1 (to update) + * \param nbdy pointer to the number of boundaries found minus 1 (to update) * \param silent if 1, print error message for more than 2 boundary triangles * in the shell * @@ -1765,15 +1765,15 @@ int MMG3D_coquilFaceFirstLoop(MMG5_pMesh mesh,MMG5_int start,MMG5_int na,MMG5_in } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param piv global index of the pivot. * \param iface index of the face from which we come. * \param i index of edge whose shell is computed (in tetra). - * \param list pointer toward the list of tetra in the shell (to fill). - * \param ilist pointer toward the number of tetra in the shell (to fill). - * \param it1 pointer toward the index of the 1st boundary face sharing \a ia - * \param pradj pointer toward the first tetra of the shell (to fill). - * \param adj pointer toward the adjacent to treat in the shell (to update) + * \param list pointer to the list of tetra in the shell (to fill). + * \param ilist pointer to the number of tetra in the shell (to fill). + * \param it1 pointer to the index of the 1st boundary face sharing \a ia + * \param pradj pointer to the first tetra of the shell (to fill). + * \param adj pointer to the adjacent to treat in the shell (to update) * * Initialize the travel in the shell of the edge in reverse direction than in * the \a coquilFaceFirstLoop function. @@ -1815,14 +1815,14 @@ void MMG3D_coquilFaceSecondLoopInit(MMG5_pMesh mesh,MMG5_int piv,int8_t *iface, } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param start index of the starting tetrahedron. * \param iface index of the boundary face from which we come. * \param ia index of edge whose shell is computed (in tetra). - * \param list pointer toward the list of tetra in the shell (to fill). - * \param it1 pointer toward the index of the first boundary face sharing \a ia + * \param list pointer to the list of tetra in the shell (to fill). + * \param it1 pointer to the index of the first boundary face sharing \a ia * (to fill). - * \param it2 pointer toward the index of the second boundary face sharing \a ia + * \param it2 pointer to the index of the second boundary face sharing \a ia * (to fill). * \param silent if 1, print error message for more than 2 boundary triangles * in the shell @@ -1935,7 +1935,7 @@ int MMG5_coquilface(MMG5_pMesh mesh,MMG5_int start,int8_t iface,int ia,int64_t * } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param na global index of edge extremity. * \param nb global index of edge extremity. * \param adj starting tetrahedron at the begining and finish tet at the end. @@ -1987,7 +1987,7 @@ int16_t MMG5_coquilTravel(MMG5_pMesh mesh, MMG5_int na, MMG5_int nb, MMG5_int* a } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param na global index of edge extremity. * \param nb global index of edge extremity. * \param adj starting tetrahedron at the begining and finish tet at the end. diff --git a/src/mmg3d/cenrad_3d.c b/src/mmg3d/cenrad_3d.c index 34b6005cc..aa19fc509 100644 --- a/src/mmg3d/cenrad_3d.c +++ b/src/mmg3d/cenrad_3d.c @@ -33,7 +33,7 @@ #include "libmmg3d_private.h" /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param ct coordinates of vertices of the element. * \param c center of circumscribing circle to the element. * \param rad squared radius of circumscribing circle to the element. @@ -128,7 +128,7 @@ int MMG5_cenrad_iso(MMG5_pMesh mesh,double *ct,double *c,double *rad) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param ct coordinates of vertices of the element. * \param m metric at the point for which we compute the cavity. * \param c center of circumscribing circle to the element. diff --git a/src/mmg3d/chkmsh_3d.c b/src/mmg3d/chkmsh_3d.c index 4cc929f7c..c6c05e39e 100644 --- a/src/mmg3d/chkmsh_3d.c +++ b/src/mmg3d/chkmsh_3d.c @@ -42,7 +42,7 @@ extern int8_t ddb; /** - * \param mesh pointer toward mesh + * \param mesh pointer to mesh * * Test that tetra have positive volumes. * @@ -72,7 +72,7 @@ void MMG5_chkvol(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh + * \param mesh pointer to the mesh * \param start tetra from which we start to travel * \param na edge vertex * \param nb edge vertex @@ -128,7 +128,7 @@ int MMG3D_chk_shellEdgeTag_oneDir(MMG5_pMesh mesh,MMG5_int start, MMG5_int na, } /** - * \param mesh pointer toward the mesh + * \param mesh pointer to the mesh * \param start tetra from which we start to travel * \param ia local index of edge that must be updated * \param tag edge tag @@ -191,7 +191,7 @@ int MMG3D_chk_shellEdgeTag(MMG5_pMesh mesh,MMG5_int start, int8_t ia,int16_t ta } /** - * \param mesh pointer toward the mesh + * \param mesh pointer to the mesh * * Test consistency between the tags in the xtetra of all mesh edges marked as * boundaries. @@ -269,7 +269,7 @@ void MMG3D_chkmeshedgestags(MMG5_pMesh mesh) { /** - * \param mesh pointer toward the mesh + * \param mesh pointer to the mesh * \param ip1 first vertex of edge to test * \param ip2 second vertex of edge to test * \param tag edge tag @@ -306,8 +306,8 @@ void MMG3D_chkedgetag(MMG5_pMesh mesh, MMG5_int ip1, MMG5_int ip2, int tag) { } /** - * \param mesh pointer toward the mesh - * \param ppt pointer toward unconsistent point + * \param mesh pointer to the mesh + * \param ppt pointer to unconsistent point * \param k tetra index * \param i local index of edge in tetra \a k * \param ip1 first vertex of edge to test @@ -423,7 +423,7 @@ int MMG5_chkmshsurf(MMG5_pMesh mesh){ } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \return 0 if fail, 1 otherwise * * Check the number of boundary faces in each edge shell and the consistency of the edge tag. @@ -463,7 +463,7 @@ int MMG3D_chkcoquilface(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param severe level of performed check (unused) * \param base unused argument. * \return 0 if fail, 1 if success. @@ -776,7 +776,7 @@ int MMG5_cntbdypt(MMG5_pMesh mesh, MMG5_int nump){ } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * * \return 0 if fail, 1 otherwise. * diff --git a/src/mmg3d/colver_3d.c b/src/mmg3d/colver_3d.c index 5dbd36951..c7eefa722 100644 --- a/src/mmg3d/colver_3d.c +++ b/src/mmg3d/colver_3d.c @@ -174,14 +174,14 @@ int MMG5_chkcol_int(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int k,int8_t iface, } /** - * \param mesh pointer toward the mesh + * \param mesh pointer to the mesh * \param start tetra from which we start to travel * \param end tetra at which we stop the travel * \param na edge vertex * \param nb edge vertex * \param piv global index of the pivot to set the sense of travel - * \param iel pointer toward the last element of the shell - * \param iopp pointer toward the ending boundary face of the shell + * \param iel pointer to the last element of the shell + * \param iopp pointer to the ending boundary face of the shell * * \return -1 if fail, \a piv otherwise. * @@ -230,7 +230,7 @@ MMG5_int MMG3D_unfold_shell(MMG5_pMesh mesh,MMG5_int start,MMG5_int end, MMG5_i } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param k index of the starting tetra. * \param iface local index of the starting face in the tetra \a k. * \param ideg local index of the starting edge in the face \a iface. @@ -354,7 +354,7 @@ MMG5_topchkcol_bdy(MMG5_pMesh mesh,MMG5_int k,int iface,int8_t iedg,MMG5_int *li } /** - * \param mesh pointer toward the mesh + * \param mesh pointer to the mesh * \param start tetra from which we start to travel * \param na edge vertex * \param nb edge vertex @@ -420,7 +420,7 @@ int MMG3D_get_shellEdgeTag_oneDir(MMG5_pMesh mesh,MMG5_int start, MMG5_int na, } /** - * \param mesh pointer toward the mesh + * \param mesh pointer to the mesh * \param start tetra from which we start to travel * \param ia local index of edge that must be updated * \param tag new edge tag @@ -490,14 +490,14 @@ int MMG3D_get_shellEdgeTag(MMG5_pMesh mesh,MMG5_int start, int8_t ia,int16_t *t } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k index of element in which we collapse. * \param iface face through wich we perform the collapse * \param iedg edge to collapse (in local face num) - * \param listv pointer toward the list of the tetra in the ball of \a p0. + * \param listv pointer to the list of the tetra in the ball of \a p0. * \param ilistv number of tetra in the ball of \a p0. - * \param lists pointer toward the surfacic ball of \a p0. + * \param lists pointer to the surfacic ball of \a p0. * \param ilists number of tetra in the surfacic ball of \a p0. * \param refmin reference of one of the two subdomains in presence * \param refplus reference of the other subdomain in presence @@ -989,7 +989,7 @@ void MMG3D_update_edgeTag(MMG5_pTetra pt,MMG5_pxTetra pxt,MMG5_int np, MMG5_int } /** - * \param mesh pointer toward the mesh + * \param mesh pointer to the mesh * \param start tetra from which we start to travel * \param na edge vertex * \param nb edge vertex @@ -1059,7 +1059,7 @@ MMG5_int MMG3D_update_shellEdgeTag_oneDir(MMG5_pMesh mesh,MMG5_int start, MMG5_ } /** - * \param mesh pointer toward the mesh + * \param mesh pointer to the mesh * \param start tetra from which we start to travel * \param ia local index of edge that must be updated * \param tag new edge tag @@ -1132,9 +1132,9 @@ int MMG3D_update_shellEdgeTag(MMG5_pMesh mesh,MMG5_int start, int8_t ia,int16_t } /** - * \param mesh pointer toward the mesh - * \param met pointer toward the metric - * \param list pointer toward the ball of the point + * \param mesh pointer to the mesh + * \param met pointer to the metric + * \param list pointer to the ball of the point * \param ilist number of elements in the ball of the point * \param indq local index of the point on which we collapse * \param typchk type of check performed depending on the remeshing step diff --git a/src/mmg3d/delaunay_3d.c b/src/mmg3d/delaunay_3d.c index 5db5c0391..a072995b4 100644 --- a/src/mmg3d/delaunay_3d.c +++ b/src/mmg3d/delaunay_3d.c @@ -126,10 +126,10 @@ int MMG5_hashEdgeDelone(MMG5_pMesh mesh,MMG5_Hash *hash,MMG5_int iel,int i,MMG5_ } /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solution structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solution structure. * \param ip index of the point to insert. - * \param list pointer toward the list of the tetra in the cavity (computed by + * \param list pointer to the list of the tetra in the cavity (computed by * \ref MMG5_cavity). * \param ilist number of tetra inside the cavity. * \return 1 if sucess, 0 or -1 if fail. @@ -336,8 +336,8 @@ int MMG5_delone(MMG5_pMesh mesh,MMG5_pSol sol,MMG5_int ip,int64_t *list,int ilis } /** - * \param mesh pointer toward the mesh structure - * \param met pointer toward the met structure + * \param mesh pointer to the mesh structure + * \param met pointer to the met structure * \param ip index of the point to insert * \param list poiner toward the cavity of the point * \param ilist number of elts in the cavity @@ -462,8 +462,8 @@ static int MMG5_correction_ani(MMG5_pMesh mesh,MMG5_pSol met,int ip,int64_t* lis /** - * \param mesh pointer toward the mesh structure - * \param met pointer toward the met structure + * \param mesh pointer to the mesh structure + * \param met pointer to the met structure * \param ip index of the point to insert * \param list poiner toward the cavity of the point * \param ilist number of elts in the cavity @@ -565,11 +565,11 @@ MMG5_correction_iso(MMG5_pMesh mesh,int ip,int64_t *list,int ilist,int nedep,dou /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the sol structure. * \param iel tetra index. * \param ip point local index in \a iel. - * \param list pointer toward the list of tetra in the shell of edge where + * \param list pointer to the list of tetra in the shell of edge where * ip will be inserted. * \param lon number of tetra in the list. * \return ilist number of tetra inside the cavity or -ilist if one of the tet @@ -725,11 +725,11 @@ int MMG5_cavity_ani(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int iel,int ip,int64_t* l /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure. * \param iel tetra index. * \param ip point local index in \a iel. - * \param list pointer toward the list of tetra in the shell of edge where + * \param list pointer to the list of tetra in the shell of edge where * ip will be inserted. * \param lon number of tetra in the list. * \return ilist number of tetra inside the cavity or -ilist if one of the tet diff --git a/src/mmg3d/hash_3d.c b/src/mmg3d/hash_3d.c index 42e28bf22..1ac283ebe 100644 --- a/src/mmg3d/hash_3d.c +++ b/src/mmg3d/hash_3d.c @@ -40,7 +40,7 @@ extern int8_t ddb; /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * * \return 1 if success, 0 if fail * @@ -111,7 +111,7 @@ MMG5_int MMG5_hashGetFace(MMG5_Hash *hash,MMG5_int ia,MMG5_int ib,MMG5_int ic) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param pack we pack the mesh at function begining if \f$pack=1\f$. * \return 0 if failed, 1 otherwise. * @@ -232,7 +232,7 @@ int MMG3D_hashTetra(MMG5_pMesh mesh, int pack) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * * \return 0 if failed, 1 otherwise. * @@ -630,7 +630,7 @@ int MMG5_skip_ParBdy ( int8_t tag ) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * * \return 1 if success, 0 if fail. * Seek the non-required non-manifold points and try to analyse whether they are @@ -837,7 +837,7 @@ int MMG5_setNmTag(MMG5_pMesh mesh, MMG5_Hash *hash) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param hash Edges hash table. * \return 1 if success, 0 if failed. * @@ -910,7 +910,7 @@ int MMG5_hashPop(MMG5_Hash *hash,MMG5_int a,MMG5_int b) { /** - * \param hash pointer toward the hash table in which edges are stored + * \param hash pointer to the hash table in which edges are stored * \param a first edge extremity * \param b second edge extremity * \param ref reference to assign to the edge @@ -1112,7 +1112,7 @@ int MMG5_hNew(MMG5_pMesh mesh,MMG5_HGeom *hash,MMG5_int hsiz,MMG5_int hmax) { } /** - * \param mesh pointer toward he mesh structure. + * \param mesh pointer to he mesh structure. * \return 0 if failed, 1 otherwise * * Build hashtable for initial mesh edges. @@ -1533,7 +1533,7 @@ int MMG5_bdryTria(MMG5_pMesh mesh, MMG5_int ntmesh) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \return 1 if success, 0 otherwise. * * - Remove double triangles from tria array. @@ -1853,7 +1853,7 @@ int MMG5_chkBdryTria(MMG5_pMesh mesh) { /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \return 0 if failed, 1 if success. * * Set the triangles references to the tetrahedra faces and edges. @@ -2243,7 +2243,7 @@ int MMG5_bdryUpdate(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \return 0 if failed, 1 otherwise. * * Make orientation of triangles compatible with tetra faces for external tria diff --git a/src/mmg3d/inlined_functions_3d_private.h b/src/mmg3d/inlined_functions_3d_private.h index 3c4cbf948..8e0fe5168 100644 --- a/src/mmg3d/inlined_functions_3d_private.h +++ b/src/mmg3d/inlined_functions_3d_private.h @@ -41,10 +41,10 @@ /** * \brief Compute edge length from edge's coordinates. - * \param ca pointer toward the coordinates of the first edge's extremity. - * \param cb pointer toward the coordinates of the second edge's extremity. - * \param sa pointer toward the metric associated to the first edge's extremity. - * \param sb pointer toward the metric associated to the second edge's extremity. + * \param ca pointer to the coordinates of the first edge's extremity. + * \param cb pointer to the coordinates of the second edge's extremity. + * \param sa pointer to the metric associated to the first edge's extremity. + * \param sb pointer to the metric associated to the second edge's extremity. * \return edge length. * * Compute length of edge \f$[ca,cb]\f$ (with \a ca and \a cb @@ -80,10 +80,10 @@ inline double MMG5_lenedgCoor_ani(double *ca,double *cb,double *sa,double *sb) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the sol structure. * \param ia index of edge in tetra \a pt . - * \param pt pointer toward the tetra from which we come. + * \param pt pointer to the tetra from which we come. * \return length of edge according to the prescribed metric. * * Compute length of edge \f$[i0;i1]\f$ according to the prescribed aniso @@ -111,10 +111,10 @@ inline double MMG5_lenedg33_ani(MMG5_pMesh mesh ,MMG5_pSol met, int ia, } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the sol structure. * \param ia index of edge in tetra \a pt . - * \param pt pointer toward the tetra from which we come. + * \param pt pointer to the tetra from which we come. * \return length of edge according to the prescribed metric. * * Compute length of edge \f$[i0;i1]\f$ according to the prescribed aniso @@ -144,10 +144,10 @@ inline double MMG5_lenedgspl33_ani(MMG5_pMesh mesh ,MMG5_pSol met, int ia, /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the sol structure. * \param ia index of edge in tetra \a pt . - * \param pt pointer toward the tetra from which we come. + * \param pt pointer to the tetra from which we come. * \return length of edge according to the prescribed metric, 0 if fail. * * Compute length of edge \f$[i0;i1]\f$ according to the prescribed aniso @@ -187,10 +187,10 @@ inline double MMG5_lenedgspl_ani(MMG5_pMesh mesh ,MMG5_pSol met, int ia, } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the sol structure. * \param ia index of edge in tetra \a pt . - * \param pt pointer toward the tetra from which we come. + * \param pt pointer to the tetra from which we come. * \return length of edge according to the prescribed metric. * * Compute length of edge \f$[i0;i1]\f$ according to the prescribed aniso @@ -217,10 +217,10 @@ inline double MMG5_lenedg_ani(MMG5_pMesh mesh ,MMG5_pSol met, int ia, } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the sol structure. * \param ia index of edge in tetra \a pt . - * \param pt pointer toward the tetra from which we come. + * \param pt pointer to the tetra from which we come. * \return length of edge according to the prescribed metric. * * Compute length of edge \f$[i0;i1]\f$ according to the prescribed iso @@ -251,8 +251,8 @@ inline double MMG5_lenedgspl_iso(MMG5_pMesh mesh ,MMG5_pSol met, int ia, /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the meric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the meric structure. * \param iel index of element. * \return The oriented quality of element \a iel or 0.0 if \a iel is inverted. * @@ -270,9 +270,9 @@ inline double MMG5_orcal(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int iel) { /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the meric structure. - * \param pt pointer toward a tetrahedra. + * \param mesh pointer to the mesh structure. + * \param met pointer to the meric structure. + * \param pt pointer to a tetrahedra. * \return The isotropic quality of the tet in LES measure, 0 if fail * * Compute the quality of the tet pt with respect to the LES quality measure. @@ -315,10 +315,10 @@ inline double MMG3D_caltetLES_iso(MMG5_pMesh mesh,MMG5_pSol met,MMG5_pTetra pt) } /** - * \param a pointer toward the coor of the first tetra vertex. - * \param b pointer toward the coor of the second tetra vertex. - * \param c pointer toward the coor of the third tetra vertex. - * \param d pointer toward the coor of the fourth tetra vertex. + * \param a pointer to the coor of the first tetra vertex. + * \param b pointer to the coor of the second tetra vertex. + * \param c pointer to the coor of the third tetra vertex. + * \param d pointer to the coor of the fourth tetra vertex. * \return The isotropic quality of the tet. * * Compute the quality of a tetra given by 4 points a,b,c,d with respect to the @@ -375,9 +375,9 @@ inline double MMG5_caltet_iso_4pt(double *a, double *b, double *c, double *d) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param pt pointer toward a tetrahedra. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param pt pointer to a tetrahedra. * \return The isotropic quality of the tet. * * Compute the quality of the tet pt with respect to the isotropic metric \a @@ -404,9 +404,9 @@ inline double MMG5_caltet_iso(MMG5_pMesh mesh,MMG5_pSol met,MMG5_pTetra pt) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the meric structure. - * \param pt pointer toward a tetrahedra. + * \param mesh pointer to the mesh structure. + * \param met pointer to the meric structure. + * \param pt pointer to a tetrahedra. * \return The anisotropic quality of the tet or 0.0 if fail. * * Compute the quality of the tet pt with respect to the anisotropic metric \a diff --git a/src/mmg3d/inout_3d.c b/src/mmg3d/inout_3d.c index 83d1b72e8..9edef4b32 100644 --- a/src/mmg3d/inout_3d.c +++ b/src/mmg3d/inout_3d.c @@ -39,7 +39,7 @@ /** * \param imprim verbosity level (muted for stdout if -1) * \param filename file to open - * \param inm pointer toward the file unit + * \param inm pointer to the file unit * \param bin 1 if file will be at binary format * \param modeASCII mode in which to open an ascii file ("r","r+","w","w+",...) * \param modeASCII mode in which to open an ascii file ("r","r+","w","w+",...) @@ -1032,7 +1032,7 @@ int MMG3D_loadMesh_opened(MMG5_pMesh mesh,FILE *inm,int bin) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param filename name of file. * * \return 0 if the file is not found, -1 if we detect mismatch parameters or we @@ -1247,8 +1247,8 @@ int MMG3D_loadGenericMesh(MMG5_pMesh mesh, MMG5_pSol met, MMG5_pSol sol, const c } /** - * \param mesh pointer toward the mesh structure. - * \param filename pointer toward the name of file. + * \param mesh pointer to the mesh structure. + * \param filename pointer to the name of file. * \return 0 if failed, 1 otherwise. * * Save mesh data. diff --git a/src/mmg3d/intmet_3d.c b/src/mmg3d/intmet_3d.c index 1b35af5c1..47fe92339 100644 --- a/src/mmg3d/intmet_3d.c +++ b/src/mmg3d/intmet_3d.c @@ -36,8 +36,8 @@ #include "libmmg3d_private.h" /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k element index. * \param i local index of edge in \a k. * \param ip global index of the new point in which we want to compute the metric. @@ -86,8 +86,8 @@ int MMG5_intmet_ani(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int k,int8_t i,MMG5_int i } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k element index. * \param i local index of edge in \a k. * \param ip global index of the new point in which we want to compute the metric. @@ -111,7 +111,7 @@ int MMG3D_intmet33_ani(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int k,int8_t i,MMG5_in } /** - * \param met pointer toward the metric structure. + * \param met pointer to the metric structure. * \param ip1 first global index of edge extremities. * \param ip2 second global index of edge extremities. * \param ip global index of the new point in which we want to compute the metric. @@ -134,8 +134,8 @@ int MMG3D_intmet33_ani_edge(MMG5_pSol met,MMG5_int ip1,MMG5_int ip2,MMG5_int ip, } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k element index. * \param i local index of edge in \a k. * \param ip global index of the new point in which we want to compute the metric. @@ -159,7 +159,7 @@ int MMG5_intmet_iso(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int k,int8_t i,MMG5_int i } /** - * \param met pointer toward the metric structure. + * \param met pointer to the metric structure. * \param ip1 first global index of edge extremities. * \param ip2 second global index of edge extremities. * \param ip global index of the new point in which we want to compute the metric. @@ -181,8 +181,8 @@ int MMG5_intmet_iso_edge(MMG5_pSol met,MMG5_int ip1,MMG5_int ip2,MMG5_int ip, } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k element index. * \param i local index of edge in \a k. * \param s interpolation parameter. @@ -279,8 +279,8 @@ MMG5_intregvolmet(double *ma,double *mb,double *mp,double t) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k element index. * \param i local index of edge in \a k. * \param s interpolation parameter. @@ -341,8 +341,8 @@ int MMG5_intvolmet(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int k,int8_t i,double s, return 1; } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k index of the tetra. * \param ip index of the point on which we compute the metric. * \param cb barycentric coordinates of \a ip in \a k. @@ -366,7 +366,7 @@ int MMG5_interp4bar_iso(MMG5_pMesh mesh, MMG5_pSol met, MMG5_int k, MMG5_int ip, } /** - * \param met pointer toward the metric structure. + * \param met pointer to the metric structure. * \param ip index of the point on which we compute the metric. * \param cb barycentric coordinates of \a ip in the tetra. * \param dm0 metric of the first vertex of the tet. @@ -411,8 +411,8 @@ int MMG5_interp4barintern(MMG5_pSol met,MMG5_int ip,double cb[4],double dm0[6], } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k index of the tetra. * \param ip index of the point on which we compute the metric. * \param cb barycentric coordinates of \a ip in \a k. @@ -483,8 +483,8 @@ int MMG5_interp4bar_ani(MMG5_pMesh mesh, MMG5_pSol met, MMG5_int k, MMG5_int ip, } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k index of the tetra. * \param ip index of the point on which we compute the metric. * \param cb barycentric coordinates of \a ip in \a k. diff --git a/src/mmg3d/isosiz_3d.c b/src/mmg3d/isosiz_3d.c index 15065e52c..7b9ccdf34 100644 --- a/src/mmg3d/isosiz_3d.c +++ b/src/mmg3d/isosiz_3d.c @@ -47,10 +47,10 @@ extern int8_t ddb; /** * \brief Compute edge length from edge's coordinates. - * \param *ca pointer toward the coordinates of the first edge's extremity. - * \param *cb pointer toward the coordinates of the second edge's extremity. - * \param *ma pointer toward the metric associated to the first edge's extremity. - * \param *mb pointer toward the metric associated to the second edge's extremity. + * \param *ca pointer to the coordinates of the first edge's extremity. + * \param *cb pointer to the coordinates of the second edge's extremity. + * \param *ma pointer to the metric associated to the first edge's extremity. + * \param *mb pointer to the metric associated to the second edge's extremity. * \return edge length. * * Compute length of edge \f$[ca,cb]\f$ (with \a ca and \a cb @@ -73,10 +73,10 @@ inline double MMG5_lenedgCoor_iso(double *ca,double *cb,double *ma,double *mb) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param nump index of point in which the size must be computed. - * \param lists pointer toward the surfacic ball of \a nump. + * \param lists pointer to the surfacic ball of \a nump. * \param ilists size of surfacic ball of \a nump. * \param hmin minimal edge size. * \param hmax maximal edge size. @@ -465,10 +465,10 @@ MMG5_defsizreg(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int nump,MMG5_int *lists, } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param nump index of point in which the size must be computed. - * \param lists pointer toward the surfacic ball of \a nump. + * \param lists pointer to the surfacic ball of \a nump. * \param ilists size of surfacic ball of \a nump. * \param hmin minimal edge size. * \param hmax maximal edge size. @@ -516,8 +516,8 @@ double MMG5_meansizreg_iso(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int nump,MMG5_int } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param hash edge hashtable. * \param pt tetra to process. * \param i index of the edge of the tetra \a pt that we process. @@ -550,8 +550,8 @@ int MMG3D_sum_reqEdgeLengthsAtPoint(MMG5_pMesh mesh,MMG5_pSol met,MMG5_Hash *has } /** - * \param mesh pointer toward the mesh - * \param met pointer toward the metric + * \param mesh pointer to the mesh + * \param met pointer to the metric * \param ismet 1 if user provided metric * * \return 0 if fail, 1 otherwise @@ -650,8 +650,8 @@ int MMG3D_set_metricAtPointsOnReqEdges ( MMG5_pMesh mesh,MMG5_pSol met,int8_t is } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \return 0 if fail, 1 otherwise. * * Define isotropic size map at all boundary vertices of the mesh, associated @@ -1039,7 +1039,7 @@ int MMG3D_defsiz_iso(MMG5_pMesh mesh,MMG5_pSol met) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * * Set the s field of the points that belongs to a required edge to 4*ne+3, set it to * 0 otherwise. @@ -1073,8 +1073,8 @@ void MMG3D_mark_pointsOnReqEdge_fromTetra ( MMG5_pMesh mesh ) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \return 0 if fail, 1 otherwise. * * Enforce mesh gradation by truncating size map. @@ -1158,8 +1158,8 @@ int MMG3D_gradsiz_iso(MMG5_pMesh mesh,MMG5_pSol met) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \return 0 if fail, 1 otherwise. * * Enforce mesh gradation by truncating size map. diff --git a/src/mmg3d/libmmg3d.c b/src/mmg3d/libmmg3d.c index 60fa581ec..aab14438e 100644 --- a/src/mmg3d/libmmg3d.c +++ b/src/mmg3d/libmmg3d.c @@ -89,7 +89,7 @@ void MMG3D_Free_topoTables(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh structure (unused). + * \param mesh pointer to the mesh structure (unused). * \return -1 if fail, the number of detected ridges otherwise * * Create the boundary entities of the mesh (triangles and edges). @@ -187,9 +187,9 @@ MMG5_int MMG3D_bdryBuild(MMG5_pMesh mesh) { #ifndef USE_SCOTCH /** - * \param mesh pointer toward the mesh structure (unused). - * \param np pointer toward the number of used points - * \param nc pointer toward the number of packed corners + * \param mesh pointer to the mesh structure (unused). + * \param np pointer to the number of used points + * \param nc pointer to the number of packed corners * \return 1 if success, 0 if fail. * * Pack the mesh points and store the packed point index in tmp. @@ -264,7 +264,7 @@ int MMG3D_mark_packedPoints(MMG5_pMesh mesh,MMG5_int *np,MMG5_int *nc) { } /** - * \param mesh pointer toward the mesh structure + * \param mesh pointer to the mesh structure * * \return 1 if success, 0 if fail. * @@ -324,7 +324,7 @@ int MMG3D_pack_tetraAndAdja(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh structure + * \param mesh pointer to the mesh structure * * \return 1 if success, 0 if fail. * @@ -369,7 +369,7 @@ int MMG3D_pack_tetra(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh structure + * \param mesh pointer to the mesh structure * * \return 1 if success, 0 if fail. * @@ -413,8 +413,8 @@ int MMG3D_pack_prismsAndQuads(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh structure (unused). - * \param met pointer toward the solution (metric or level-set) structure. + * \param mesh pointer to the mesh structure (unused). + * \param met pointer to the solution (metric or level-set) structure. * \return 1 if success, 0 if fail. * * Pack a sparse solution structure. Don't preserve numbering order. @@ -463,7 +463,7 @@ int MMG3D_pack_sol(MMG5_pMesh mesh,MMG5_pSol sol) { } /** - * \param mesh pointer toward the mesh structure (unused). + * \param mesh pointer to the mesh structure (unused). * \return the number of corners if success, -1 otherwise * * Pack a sparse point array. Don't preserve numbering order. @@ -528,9 +528,9 @@ int MMG3D_pack_pointArray(MMG5_pMesh mesh) { #else /** - * \param mesh pointer toward the mesh structure (unused). - * \param np pointer toward the number of packed points - * \param nc pointer toward the number of packed corners + * \param mesh pointer to the mesh structure (unused). + * \param np pointer to the number of packed points + * \param nc pointer to the number of packed corners * \return 1 if success, 0 if fail. * * Count the number of packed points and store the packed point index in tmp. @@ -561,7 +561,7 @@ int MMG3D_mark_packedPoints(MMG5_pMesh mesh,MMG5_int *np,MMG5_int *nc) { } /** - * \param mesh pointer toward the mesh structure + * \param mesh pointer to the mesh structure * * \return 1 if success, 0 if fail. * @@ -616,7 +616,7 @@ int MMG3D_pack_tetraAndAdja(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh structure + * \param mesh pointer to the mesh structure * * \return 1 if success, 0 if fail. * @@ -657,7 +657,7 @@ int MMG3D_pack_tetra(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh structure + * \param mesh pointer to the mesh structure * * \return 1 if success, 0 if fail. * @@ -703,8 +703,8 @@ int MMG3D_pack_prismsAndQuads(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh structure (unused). - * \param met pointer toward the solution (metric or level-set) structure. + * \param mesh pointer to the mesh structure (unused). + * \param met pointer to the solution (metric or level-set) structure. * \return 1 if success, 0 if fail. * * Pack a sparse solution structure. Preserve numbering order. @@ -740,7 +740,7 @@ int MMG3D_pack_sol(MMG5_pMesh mesh,MMG5_pSol sol) { } /** - * \param mesh pointer toward the mesh structure (unused). + * \param mesh pointer to the mesh structure (unused). * \return the number of corners if success, -1 otherwise * * Pack a sparse point array. Preserve numbering order. @@ -797,7 +797,7 @@ int MMG3D_pack_pointArray(MMG5_pMesh mesh) { /** - * \param mesh pointer toward the mesh structure (unused). + * \param mesh pointer to the mesh structure (unused). * \return 1 if success, 0 otherwise * * Update the element vertices indices with the pack point index stored in the @@ -843,7 +843,7 @@ int MMG3D_update_eltsVertices(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh structure (unused). + * \param mesh pointer to the mesh structure (unused). * \return the number of corners if success, -1 otherwise * * Pack a sparse point array and update the element vertices according to their @@ -893,9 +893,9 @@ void MMG3D_unset_reqBoundaries(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh structure (unused). - * \param sol pointer toward a solution structure. - * \param met pointer toward a solution structure. + * \param mesh pointer to the mesh structure (unused). + * \param sol pointer to a solution structure. + * \param met pointer to a solution structure. * \return 1 if success, 0 if fail or if we are unable to build triangles. * * Pack the sparse mesh and create triangles and edges before getting diff --git a/src/mmg3d/libmmg3d_private.h b/src/mmg3d/libmmg3d_private.h index 18504ed8f..cf80a2e78 100644 --- a/src/mmg3d/libmmg3d_private.h +++ b/src/mmg3d/libmmg3d_private.h @@ -545,7 +545,7 @@ int MMG3D_openMesh(int imprim,const char *filename,FILE **inm,int *bin,char*,cha int MMG3D_loadMesh_opened(MMG5_pMesh mesh,FILE *inm,int bin); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * * Warn user that some tetrahedra of the mesh have been reoriented. * diff --git a/src/mmg3d/libmmg3d_tools.c b/src/mmg3d/libmmg3d_tools.c index b425aa61f..977a495ca 100644 --- a/src/mmg3d/libmmg3d_tools.c +++ b/src/mmg3d/libmmg3d_tools.c @@ -197,11 +197,11 @@ int MMG3D_defaultValues(MMG5_pMesh mesh) { /** * \param argc number of command line args * \param argv command line args - * \param mesh pointer toward the mesh - * \param met pointer toward the metric - * \param sol pointer toward the solution (level-set or displacement) - * \param mmgArgc pointer toward the number of appened unknown args (to fill) - * \param mmgArgv pointer toward the appened unknown args (to fill) + * \param mesh pointer to the mesh + * \param met pointer to the metric + * \param sol pointer to the solution (level-set or displacement) + * \param mmgArgc pointer to the number of appened unknown args (to fill) + * \param mmgArgv pointer to the appened unknown args (to fill) * * \return 1 if success, 0 if fail (missing value for argument) * @@ -1420,8 +1420,8 @@ int MMG3D_searchlen(MMG5_pMesh mesh, MMG5_pSol met, double lmin, } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the solution structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the solution structure. * \param ani 1 for aniso metric, 0 for iso one * * \return 0 if fail, 1 if succeed. @@ -1470,8 +1470,8 @@ int MMG3D_solTruncatureForOptim(MMG5_pMesh mesh, MMG5_pSol met,int ani) { } /** - * \param mesh pointer toward the mesh - * \param met pointer toward the metric + * \param mesh pointer to the mesh + * \param met pointer to the metric * * \return 1 if succeed, 0 if fail * @@ -1545,8 +1545,8 @@ int MMG3D_doSol_iso(MMG5_pMesh mesh,MMG5_pSol met) { } /** - * \param mesh pointer toward the mesh - * \param met pointer toward the metric + * \param mesh pointer to the mesh + * \param met pointer to the metric * * \return 1 if succeed, 0 if fail * diff --git a/src/mmg3d/librnbg_3d.c b/src/mmg3d/librnbg_3d.c index 4b40c6f43..7855590ee 100644 --- a/src/mmg3d/librnbg_3d.c +++ b/src/mmg3d/librnbg_3d.c @@ -39,8 +39,8 @@ #include "librnbg_private.h" /** - * \param tetras pointer toward a table containing the tetra structures. - * \param *perm pointer toward the permutation table (to perform in place + * \param tetras pointer to a table containing the tetra structures. + * \param *perm pointer to the permutation table (to perform in place * permutations). * \param ind1 index of the first tetra to swap. * \param ind2 index of the second tetra to swap. @@ -99,9 +99,9 @@ void MMG5_swapTet(MMG5_pTetra tetras/*, int* adja*/, MMG5_int* perm, MMG5_int in /** * \param boxVertNbr number of vertices by box. - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solution structure - * \param fields pointer toward an array of solution fields + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solution structure + * \param fields pointer to an array of solution fields * \param permNodGlob array to store the global permutation of nodes (non mandatory) * * \return 0 if the renumbering fail and we can't rebuild tetrahedra hashtable, diff --git a/src/mmg3d/mmg3d.c b/src/mmg3d/mmg3d.c index 392dd6ae8..863ea5444 100644 --- a/src/mmg3d/mmg3d.c +++ b/src/mmg3d/mmg3d.c @@ -49,8 +49,8 @@ static void MMG5_endcod(void) { } /** - * \param mesh pointer toward the mesh structure. - * \param bdyRefs pointer toward the list of the boundary references. + * \param mesh pointer to the mesh structure. + * \param bdyRefs pointer to the list of the boundary references. * \return npar, the number of local parameters at tetrahedra if success, * 0 otherwise. * @@ -94,9 +94,9 @@ int MMG5_countLocalParamAtTet( MMG5_pMesh mesh,MMG5_iNode **bdyRefs) { } /** - * \param mesh pointer toward the mesh structure. - * \param bdryRefs pointer toward the list of the boundary references. - * \param out pointer toward the file in which to write. + * \param mesh pointer to the mesh structure. + * \param bdryRefs pointer to the list of the boundary references. + * \param out pointer to the file in which to write. * \return 1 if success, 0 otherwise. * * Write the local default values at tetrahedra in the parameter file. @@ -120,7 +120,7 @@ int MMG5_writeLocalParamAtTet( MMG5_pMesh mesh, MMG5_iNode *bdryRefs, /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \return 1 if success, 0 otherwise. * * Write a DEFAULT.mmg3d file containing the default values of parameters that @@ -181,9 +181,9 @@ int MMG3D_writeLocalParam( MMG5_pMesh mesh ) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward a sol structure (metric). - * \param sol pointer toward a sol structure (ls or disp). + * \param mesh pointer to the mesh structure. + * \param met pointer to a sol structure (metric). + * \param sol pointer to a sol structure (ls or disp). * * \return \ref MMG5_SUCCESS if success, \ref MMG5_LOWFAILURE if failed * but a conform mesh is saved and \ref MMG5_STRONGFAILURE if failed and we diff --git a/src/mmg3d/mmg3d1.c b/src/mmg3d/mmg3d1.c index be8afb1e3..9cb8aef26 100644 --- a/src/mmg3d/mmg3d1.c +++ b/src/mmg3d/mmg3d1.c @@ -44,8 +44,8 @@ extern int8_t ddb; /** - * \param mesh pointer toward mesh - * \param ppt pointer toward point whose geom data have to be updated + * \param mesh pointer to mesh + * \param ppt pointer to point whose geom data have to be updated * \param tag point tag * \param nmref ref that has to be setted at point \a ppt if point is non-manifold * \param edgref ref that has to be setted at point \a ppt if point is manifold (edg ref) @@ -91,10 +91,10 @@ void MMG3D_set_geom(MMG5_pMesh mesh, MMG5_pPoint ppt, } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param k tetrahedron index. * \param ie face index of tetrahedron. - * \param ptt pointer toward the output triangle. + * \param ptt pointer to the output triangle. * * Set triangle corresponding to face ie of tetra k. * @@ -128,10 +128,10 @@ void MMG5_tet2tri(MMG5_pMesh mesh,MMG5_int k,int8_t ie,MMG5_Tria *ptt) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k tetrahedron index. - * \param vx pointer toward table of edges to split. + * \param vx pointer to table of edges to split. * \return 1 if success, 0 if fail. * * Find acceptable position for splitting. @@ -276,9 +276,9 @@ int MMG3D_dichoto(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int k,MMG5_int *vx) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param list pointer toward the shell of edge. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param list pointer to the shell of edge. * \param ret double of the number of tetrahedra in the shell. * \param ip new point index. * @@ -347,8 +347,8 @@ int MMG3D_dichoto1b(MMG5_pMesh mesh,MMG5_pSol met,int64_t *list,int ret,MMG5_int } /** - * \param mesh pointer toward the mesh structure. - * \param pt pointer toward the triangle. + * \param mesh pointer to the mesh structure. + * \param pt pointer to the triangle. * \param ori orientation of the triangle (1 for direct orientation, 0 otherwise). * \param hmax maximal edge length. * \param hausd maximal hausdorff distance. @@ -584,9 +584,9 @@ int8_t MMG5_chkedg(MMG5_pMesh mesh,MMG5_Tria *pt,int8_t ori, double hmax, } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param PROctree pointer toward the PROctree structure (only for delaunay). + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param PROctree pointer to the PROctree structure (only for delaunay). * \param typchk type of checking permformed for edge length (hmin or LSHORT * criterion). * \return -1 if failed and swap number otherwise. @@ -651,10 +651,10 @@ MMG5_int MMG5_swpmsh(MMG5_pMesh mesh,MMG5_pSol met,MMG3D_pPROctree PROctree, int } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param crit coefficient of quality improvment. - * \param PROctree pointer toward the PROctree structure in delaunay mode and + * \param PROctree pointer to the PROctree structure in delaunay mode and * toward the \a NULL pointer otherwise * \param typchk type of checking permformed for edge length (hmin or LSHORT * criterion) @@ -713,9 +713,9 @@ MMG5_int MMG5_swptet(MMG5_pMesh mesh,MMG5_pSol met,double crit,double declic, } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param PROctree pointer toward the PROctree structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param PROctree pointer to the PROctree structure. * \param clickSurf triangle quality threshold under which we want to move * \param clickVol tetra quality threshold under which we want to move * \param moveVol internal move @@ -877,8 +877,8 @@ MMG5_int MMG5_movtet(MMG5_pMesh mesh,MMG5_pSol met, MMG3D_pPROctree PROctree, } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param typchk type of checking permformed for edge length (hmin or LSHORT criterion). * \return -1 if failed, number of collapsed points otherwise. * @@ -1157,13 +1157,13 @@ static int MMG5_coltet(MMG5_pMesh mesh,MMG5_pSol met,int8_t typchk) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param PROctree pointer toward the PROctree structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param PROctree pointer to the PROctree structure. * \param k index of tetra in which we work. * \param imin index in \a k of edge that we consider for collapse. * \param lmin length of edge \a imin. - * \param nc pointer toward count of collapses (has to be updated) + * \param nc pointer to count of collapses (has to be updated) * * \return -1 for strong failure. * @@ -1278,8 +1278,8 @@ int MMG3D_adpcoledg(MMG5_pMesh mesh, MMG5_pSol met, /** - * \param mesh pointer toward the mesh structure. - * \param hash pointer toward the hash table of edges. + * \param mesh pointer to the mesh structure. + * \param hash pointer to the hash table of edges. * \return 0 if failed, 1 if success * * Delete the points inserted by pattern if the pattern step fail. @@ -1320,8 +1320,8 @@ int MMG3D_delPatternPts(MMG5_pMesh mesh,MMG5_Hash hash) } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param typchk type of checking permformed for edge length (hmax or MMG3D_LLONG criterion). * \return -1 if failed. * \return number of new points. @@ -1587,7 +1587,7 @@ MMG5_anatetv(MMG5_pMesh mesh,MMG5_pSol met,int8_t typchk) { } /** - * \param ppt pointer toward the point that we update + * \param ppt pointer to the point that we update * \param pxp point toward the \a oot xpoint * \param no normal at ppt * \return 0 if failed, 1 if success. @@ -1635,7 +1635,7 @@ MMG3D_update_rid_geom(MMG5_pPoint ppt, MMG5_pxPoint pxp, double no[3]) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param k index of the tetra to split. * \param i index of (boundary) face in which we work. * \param j local index in face i of the ridge. @@ -1718,7 +1718,7 @@ int MMG3D_normalAndTangent_at_sinRidge(MMG5_pMesh mesh,MMG5_int k,int i,int j, } /** - * \param mesh pointer toward mesh + * \param mesh pointer to mesh * \param k index of input tetra * \param imax index of edge in tetra \a k * \param i index of boundary face of tetra from which we will work @@ -1734,7 +1734,7 @@ int MMG3D_normalAndTangent_at_sinRidge(MMG5_pMesh mesh,MMG5_int k,int i,int j, * \param to tangent at new point \a o (to fill if needed) * \param no1 first normal at new point \a o (to fill if needed) * \param no2 second normal at new point (to fill if needed) - * \param list pointer toward edge shell (to fill) + * \param list pointer to edge shell (to fill) * \param ilist 2x edge shell size (+1 for a bdy edge) * * \return -1 for strong failure. @@ -1847,8 +1847,8 @@ int8_t MMG3D_build_bezierEdge(MMG5_pMesh mesh,MMG5_int k, } /** - * \param mesh pointer toward mesh - * \param pt pointer toward tetra on which we work + * \param mesh pointer to mesh + * \param pt pointer to tetra on which we work * \param ied index in tetra \a pt of edge on which we work * \param i index of a face of \a pt that contains \a ied. If possible we choose * a boundary face with suitable orientation (to fill) @@ -1857,8 +1857,8 @@ int8_t MMG3D_build_bezierEdge(MMG5_pMesh mesh,MMG5_int k, * \param i2 local index in tetra \a pt of second extremity of edge \a ied (to fill) * \param ip1 global index first extremity of edge \a ied (to fill) * \param ip2 global index in tetra \a pt of second extremity of edge \a ied (to fill) - * \param p0 pointer toward first extremity of edge \a ied (to fill) - * \param p1 pointer toward second extremity of edge \a ied (to fill) + * \param p0 pointer to first extremity of edge \a ied (to fill) + * \param p1 pointer to second extremity of edge \a ied (to fill) * * Search a face from wich we car reach edge \a ied. If a boundary face with * good orientation exists it is choosed prior to another face, otherwise, if @@ -1908,8 +1908,8 @@ void MMG3D_find_bdyface_from_edge(MMG5_pMesh mesh,MMG5_pTetra pt,int8_t ied, } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k index of the tetra to split. * \param pt tetra to split * \param pxt associated xtetra @@ -2027,13 +2027,13 @@ int MMG3D_splsurfedge( MMG5_pMesh mesh,MMG5_pSol met,MMG5_int k, } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k index of tetra thath we check - * \param pt pointer toward the tetra that we check - * \param pxt pointer toward the xtetra that we check + * \param pt pointer to the tetra that we check + * \param pxt pointer to the xtetra that we check * \param i index of the face in \a k that we check - * \param ptt pointer toward the virtual triangle build from the face \i of \a k. + * \param ptt pointer to the virtual triangle build from the face \i of \a k. * \param typchk type of checking permformed for edge length (hmax or MMG3D_LLONG criterion). * * \return 1 if success, 0 if fail. @@ -2141,8 +2141,8 @@ int MMG3D_chkbdyface(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int k,MMG5_pTetra pt, } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param typchk type of checking permformed for edge length (hmax or MMG3D_LLONG criterion). * \return -1 if failed. * \return number of new points. @@ -2234,8 +2234,8 @@ static MMG5_int MMG3D_anatets_ani(MMG5_pMesh mesh,MMG5_pSol met,int8_t typchk) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param typchk type of checking permformed for edge length (hmax or MMG3D_LLONG criterion). * \return -1 if failed. * \return number of new points. @@ -2690,8 +2690,8 @@ MMG3D_anatets_iso(MMG5_pMesh mesh,MMG5_pSol met,int8_t typchk) { static MMG5_int (*MMG3D_anatets)(MMG5_pMesh mesh,MMG5_pSol met,int8_t typchk); /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k index of the tetrahedron with multiple boundary faces (to be swapped) * \param metRidTyp metric storage (classic or special) * \param ifac face of the tetra \a k that give the best results for the swap23 @@ -2976,8 +2976,8 @@ static int MMG3D_anatet4_sim(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int k,int8_t met } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param nf number of swap performed. * \param typchk type of checking permformed. * \return -1 if failed, number of new points otherwise. @@ -3061,8 +3061,8 @@ static MMG5_int MMG5_anatet4(MMG5_pMesh mesh, MMG5_pSol met,MMG5_int *nf, int8_t } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param nf number of swap performed. * \param typchk type of checking permformed. * \return -1 if failed, number of new points otherwise. @@ -3105,8 +3105,8 @@ static MMG5_int MMG5_anatet4rid(MMG5_pMesh mesh, MMG5_pSol met,MMG5_int *nf, int /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param typchk type of checking for edges length. * \param patternMode flag to say if we perform vertex insertion by patterns * or by delaunay kernel. @@ -3119,7 +3119,7 @@ int MMG5_anatet(MMG5_pMesh mesh,MMG5_pSol met,int8_t typchk, int patternMode) { int it,minit,maxit,lastit; MMG5_int nc,ns,nnc,nns,nnf,ier,nf; - /* pointer toward the suitable anatets function */ + /* pointer to the suitable anatets function */ if ( met->m && met->size==6 ) { /* if the aniso metric is not compatible with the geometry, the non * conformal surface operators may create spurious ridges */ diff --git a/src/mmg3d/mmg3d1_delone.c b/src/mmg3d/mmg3d1_delone.c index eb397a448..52c973d2e 100644 --- a/src/mmg3d/mmg3d1_delone.c +++ b/src/mmg3d/mmg3d1_delone.c @@ -47,16 +47,16 @@ int8_t ddb; #define MMG3D_LFILTL_DEL 0.2 /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param PROctree pointer toward the PROctree structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param PROctree pointer to the PROctree structure. * \param k index of tetra in which we work. * \param imax index in \a k of edge that we consider for split. * \param lmax length of edge \a imax. * \param lmaxtet length of largest edge of tetra \a k. * \param 1 if we want to check tetra with 4 ridge metrics. * \param ifilt pointer to store the number of vertices filtered by the PROctree. - * \param ns pointer toward count of splits (has to be updated) + * \param ns pointer to count of splits (has to be updated) * \param warn pointer to store a flag that warn the user in case of * reallocation error. * \param countMemFailure number of memory errors (to update) @@ -318,9 +318,9 @@ int MMG3D_mmg3d1_delone_split(MMG5_pMesh mesh, MMG5_pSol met, } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param PROctree pointer toward the PROctree structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param PROctree pointer to the PROctree structure. * \param k index of tetra in which we work. * \param imin index in \a k of edge that we consider for split. * \param lmin length of edge \a imax. @@ -329,8 +329,8 @@ int MMG3D_mmg3d1_delone_split(MMG5_pMesh mesh, MMG5_pSol met, * \param lmaxtet length of largest edge of tetra \a k. * \param 1 if we want to check tetra with 4 ridge metrics. * \param ifilt pointer to store the number of vertices filtered by the PROctree. - * \param ns pointer toward count of splits (has to be updated) - * \param nc pointer toward count of collapses (has to be updated) + * \param ns pointer to count of splits (has to be updated) + * \param nc pointer to count of collapses (has to be updated) * \param warn pointer to store a flag that warn the user in case of * reallocation error. * @@ -403,9 +403,9 @@ int MMG3D_mmg3d1_delone_splcol(MMG5_pMesh mesh, MMG5_pSol met, } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param PROctree pointer toward the PROctree structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param PROctree pointer to the PROctree structure. * \param ne number of elements. * \param ifilt pointer to store the number of vertices filtered by the PROctree. * \param ns pointer to store the number of vertices insertions. @@ -550,9 +550,9 @@ int MMG5_adpsplcol(MMG5_pMesh mesh, MMG5_pSol met,MMG3D_pPROctree *PROctree, } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param PROctree pointer toward the PROctree structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param PROctree pointer to the PROctree structure. * \return 0 if failed, 1 otherwise. * * Mesh optimization during insertion phase. @@ -623,9 +623,9 @@ int MMG5_optbad(MMG5_pMesh mesh, MMG5_pSol met,MMG3D_pPROctree PROctree) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param PROctree pointer toward the PROctree structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param PROctree pointer to the PROctree structure. * \param warn set to 1 if we can't insert point due to lack of memory. * \return -1 if fail and we dont try to end the remesh process, * 0 if fail but we try to end the remesh process and 1 if success. @@ -740,9 +740,9 @@ int MMG5_adpdel(MMG5_pMesh mesh,MMG5_pSol met,MMG3D_pPROctree *PROctree, int* wa } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param PROctree pointer toward the PROctree structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param PROctree pointer to the PROctree structure. * \return 0 if failed, 1 otherwise. * * Mesh optimization for LES computation (improve the element skewness). @@ -834,9 +834,9 @@ int MMG5_optetLES(MMG5_pMesh mesh, MMG5_pSol met,MMG3D_pPROctree PROctree) { return 1; } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param PROctree pointer toward the PROctree structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param PROctree pointer to the PROctree structure. * \return 0 if failed, 1 otherwise. * * Mesh optimization using egde swapping and point relocation. @@ -941,9 +941,9 @@ int MMG5_optet(MMG5_pMesh mesh, MMG5_pSol met,MMG3D_pPROctree PROctree) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param PROctree pointer toward the PROctree structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param PROctree pointer to the PROctree structure. * \param permNodGlob if provided, strore the global permutation of nodes * \return 0 if failed, 1 otherwise. * @@ -1017,8 +1017,8 @@ int MMG5_adptet_delone(MMG5_pMesh mesh,MMG5_pSol met,MMG3D_pPROctree *PROctree, } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param permNodGlob if provided, strore the global permutation of nodes * \return 0 if failed, 1 if success. * diff --git a/src/mmg3d/mmg3d1_pattern.c b/src/mmg3d/mmg3d1_pattern.c index 46998fc24..2e74e1dbc 100644 --- a/src/mmg3d/mmg3d1_pattern.c +++ b/src/mmg3d/mmg3d1_pattern.c @@ -41,8 +41,8 @@ #include "mmg3dexterns_private.h" /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param *warn \a warn is set to 1 if we don't have enough memory to complete mesh. * \return -1 if failed. * \return number of new points. @@ -181,8 +181,8 @@ static MMG5_int MMG5_adpspl(MMG5_pMesh mesh,MMG5_pSol met, int* warn) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \return -1 if failed. * \return number of deleted points. * @@ -245,8 +245,8 @@ static MMG5_int MMG5_adpcol(MMG5_pMesh mesh,MMG5_pSol met) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param permNodGlob if provided, strore the global permutation of nodes. * * \return 0 if failed, 1 otherwise. @@ -416,8 +416,8 @@ static int MMG5_adptet(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int *permNodGlob) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param permNodGlob if provided, strore the global permutation of nodes. * * \return 0 if failed, 1 if success. diff --git a/src/mmg3d/mmg3d2.c b/src/mmg3d/mmg3d2.c index b10da60cb..cea8cc364 100644 --- a/src/mmg3d/mmg3d2.c +++ b/src/mmg3d/mmg3d2.c @@ -95,8 +95,8 @@ double MMG3D_vfrac_1vertex(MMG5_pPoint ppt[4],int8_t i0,double v[4],int8_t part_ /** - * \param mesh pointer toward the mesh structure - * \param sol pointer toward the ls function + * \param mesh pointer to the mesh structure + * \param sol pointer to the ls function * \param k index of the triangle * \return volfrac * @@ -301,7 +301,7 @@ double MMG3D_vfrac(MMG5_pMesh mesh,MMG5_pSol sol,MMG5_int k,int pm) { } /** - * \param mesh pointer toward the mesh. + * \param mesh pointer to the mesh. * * Reset mesh->info.isoref vertex and tetra references to 0. * @@ -390,8 +390,8 @@ MMG5_invsl(double A[3][3],double b[3],double r[3]) { } /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the level-set values. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the level-set values. * \param k index of the starting tetra. * \param indp local index (inside the tria \a k) of the vertex that we check. * \return 1 if success, 0 if fail @@ -658,8 +658,8 @@ MMG3D_ismaniball(MMG5_pMesh mesh,MMG5_pSol sol,MMG5_int k,int indp) { } /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the level-set function. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the level-set function. * \return 1 if success, 0 if fail. * * Snap values of the level set function very close to 0 to exactly 0, @@ -767,8 +767,8 @@ int MMG3D_snpval_ls(MMG5_pMesh mesh,MMG5_pSol sol) { } /** - * \param mesh pointer toward the mesh - * \param sol pointer toward the level-set + * \param mesh pointer to the mesh + * \param sol pointer to the level-set * * \return 1 if success, 0 otherwise * @@ -1015,9 +1015,9 @@ int MMG3D_rmc(MMG5_pMesh mesh, MMG5_pSol sol){ } /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the level-set values. - * \param met pointer toward a metric (non-mandatory). + * \param mesh pointer to the mesh structure. + * \param sol pointer to the level-set values. + * \param met pointer to a metric (non-mandatory). * \return 1 if success, 0 otherwise. * * Proceed to discretization of the implicit function carried by sol into mesh, @@ -1248,8 +1248,8 @@ int MMG3D_cuttet_ls(MMG5_pMesh mesh, MMG5_pSol sol,MMG5_pSol met){ /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the level-set values. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the level-set values. * \return 1. * * Set references to tets according to the sign of the level set function. @@ -1301,7 +1301,7 @@ int MMG3D_setref_ls(MMG5_pMesh mesh, MMG5_pSol sol) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \return 1 if success, 0 if the xtetra array can't be reallocated. * * Update the xtetra array to store the new bdy faces created by the isosurface @@ -1408,7 +1408,7 @@ int MMG3D_update_xtetra ( MMG5_pMesh mesh ) { } /** - * \param mesh pointer toward the mesh + * \param mesh pointer to the mesh * \param start index of the starting tetra * \param ip point index * @@ -1596,8 +1596,8 @@ int MMG3D_chkmani(MMG5_pMesh mesh){ } /** - * \param mesh pointer toward the mesh structure - * \param sol pointer toward the metric + * \param mesh pointer to the mesh structure + * \param sol pointer to the metric * * \return 1 if success, 0 otherwise. * @@ -1664,7 +1664,7 @@ int MMG3D_chkmani2(MMG5_pMesh mesh,MMG5_pSol sol) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param k index of element in which we collapse. * \param iface face through wich we perform the collapse * \param iedg edge to collapse @@ -2209,9 +2209,9 @@ int MMG3D_chkmanicoll(MMG5_pMesh mesh,MMG5_int k,int iface,int iedg,MMG5_int nde } /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the level-set. - * \param met pointer toward a metric (optionnal). + * \param mesh pointer to the mesh structure. + * \param sol pointer to the level-set. + * \param met pointer to a metric (optionnal). * \return 0 if fail, 1 otherwise. * * Create implicit surface in mesh. diff --git a/src/mmg3d/mmg3d2s.c b/src/mmg3d/mmg3d2s.c index 5d42f7fff..e3919cd15 100755 --- a/src/mmg3d/mmg3d2s.c +++ b/src/mmg3d/mmg3d2s.c @@ -39,7 +39,7 @@ extern int8_t ddb; /** - * \param mesh pointer toward the mesh. + * \param mesh pointer to the mesh. * * Reset mesh->info.isoref vertex and tetra references to 0. * @@ -96,8 +96,8 @@ int MMG3D_resetRef_lssurf(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the level-set function. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the level-set function. * \return 1 if success, 0 if fail. * * Snap values of the level set function very close to 0 to exactly 0, @@ -147,9 +147,9 @@ int MMG3D_snpval_lssurf(MMG5_pMesh mesh,MMG5_pSol sol) { } /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the level-set values. - * \param met pointer toward a metric (non-mandatory). + * \param mesh pointer to the mesh structure. + * \param sol pointer to the level-set values. + * \param met pointer to a metric (non-mandatory). * \return 1 if success, 0 otherwise. * * Proceed to discretization of the trace of the implicit function @@ -409,8 +409,8 @@ int MMG3D_cuttet_lssurf(MMG5_pMesh mesh, MMG5_pSol sol,MMG5_pSol met){ } /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the level-set values. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the level-set values. * \return 1. * * Set references to surface triangles according to the sign of the level set function. diff --git a/src/mmg3d/mmg3d3.c b/src/mmg3d/mmg3d3.c index 1501bc089..27a483b48 100644 --- a/src/mmg3d/mmg3d3.c +++ b/src/mmg3d/mmg3d3.c @@ -90,9 +90,9 @@ inline int MMG5_intdispvol(double *v1, double *v2, double *vp, double t) { } /** - * \param mesh pointer toward the mesh structure. - * \param disp pointer toward the displacement structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param disp pointer to the displacement structure. + * \param met pointer to the metric structure. * \param itdeg degraded elements. * \param *warn \a warn is set to 1 if we don't have enough memory to complete mesh. * \return -1 if failed. @@ -279,10 +279,10 @@ static MMG5_int MMG5_spllag(MMG5_pMesh mesh,MMG5_pSol disp,MMG5_pSol met,int itd } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param crit coefficient of quality improvment. - * \param PROctree pointer toward the PROctree structure in delaunay mode and + * \param PROctree pointer to the PROctree structure in delaunay mode and * toward the \a NULL pointer otherwise. * \param itdeg degraded elements. * @@ -334,8 +334,8 @@ MMG5_int MMG5_swptetlag(MMG5_pMesh mesh,MMG5_pSol met,double crit,MMG3D_pPROctre } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param itdeg degraded elements. * \return -1 if failed, number of moved points otherwise. * @@ -393,8 +393,8 @@ MMG5_int MMG5_movtetlag(MMG5_pMesh mesh,MMG5_pSol met, int itdeg) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param itdeg degraded elements. * \return -1 if failed. * \return number of collapsed points. @@ -474,8 +474,8 @@ static MMG5_int MMG5_coltetlag(MMG5_pMesh mesh,MMG5_pSol met,int itdeg) { } /** - * \param mesh pointer toward the mesh structure - * \param disp pointer toward the displacement structure. + * \param mesh pointer to the mesh structure + * \param disp pointer to the displacement structure. * \param t fraction of displacement to test * \param tetIdx to fill with the list of non valid tetra if provided. * diff --git a/src/mmg3d/movpt_3d.c b/src/mmg3d/movpt_3d.c index 21c70976b..3318674b6 100644 --- a/src/mmg3d/movpt_3d.c +++ b/src/mmg3d/movpt_3d.c @@ -39,10 +39,10 @@ #include "mmgexterns_private.h" /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param PROctree pointer toward the PROctree structure. - * \param list pointer toward the volumic ball of the point. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param PROctree pointer to the PROctree structure. + * \param list pointer to the volumic ball of the point. * \param ilist size of the volumic ball. * \param improve force the new minimum element quality to be greater or equal * than 0.9 of the old minimum element quality. @@ -161,10 +161,10 @@ int MMG5_movintpt_iso(MMG5_pMesh mesh,MMG5_pSol met, MMG3D_pPROctree PROctree, } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param PROctree pointer toward the PROctree structure. - * \param list pointer toward the volumic ball of the point. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param PROctree pointer to the PROctree structure. + * \param list pointer to the volumic ball of the point. * \param ilist size of the volumic ball. * \param improve force the new minimum element quality to be greater or equal * than 0.9 of the old minimum element quality. @@ -334,8 +334,8 @@ int MMG5_movintptLES_iso(MMG5_pMesh mesh,MMG5_pSol met, MMG3D_pPROctree PROctree } /** - * \param mesh pointer toward the mesh structure. - * \param lists pointer toward the surfacic ball of the point. + * \param mesh pointer to the mesh structure. + * \param lists pointer to the surfacic ball of the point. * \param ilists size of the surfacic ball. * \param ip0 global index of the point that we move * \param r rotation matrix that sends the normal at \a ip0 to z-axis @@ -463,8 +463,8 @@ int MMG3D_rotate_surfacicBall(MMG5_pMesh mesh,MMG5_int *lists,int ilists,MMG5_in /** -* \param mesh pointer toward the mesh -* \param lists pointer toward the surface ball of \a ip0 +* \param mesh pointer to the mesh +* \param lists pointer to the surface ball of \a ip0 * \param kel index of the current element in the ball * \param ip0 global index of the point to move * \param n normal at \a ip0 @@ -478,7 +478,7 @@ int MMG3D_rotate_surfacicBall(MMG5_pMesh mesh,MMG5_int *lists,int ilists,MMG5_in * Compute the Bezier patch at element \a lists[kel], compute the new point * coordinates, normal and tangent and check the geometric approximation. * -* \warning may invalidate n if it is a pointer toward the xpoint array +* \warning may invalidate n if it is a pointer to the xpoint array */ int MMG3D_movbdyregpt_geom(MMG5_pMesh mesh,MMG5_int *lists,const MMG5_int kel, const MMG5_int ip0,double n[3],double lambda[3],double o[3], @@ -608,12 +608,12 @@ int MMG3D_movbdyregpt_geom(MMG5_pMesh mesh,MMG5_int *lists,const MMG5_int kel, } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param PROctree pointer toward the PROctree structure. - * \param listv pointer toward the volumic ball of the point. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param PROctree pointer to the PROctree structure. + * \param listv pointer to the volumic ball of the point. * \param ilistv size of the volumic ball. - * \param lists pointer toward the surfacic ball of the point. + * \param lists pointer to the surfacic ball of the point. * \param ilists size of the surfacic ball. * \param improve force the new minimum element quality to be greater or equal * than 1.02 of the old minimum element quality. @@ -829,8 +829,8 @@ int MMG5_movbdyregpt_iso(MMG5_pMesh mesh, MMG5_pSol met, MMG3D_pPROctree PROctre } /** - * \param mesh pointer toward the mesh structure. - * \param lists pointer toward the surfacic ball of the point we want to move (\a ip0). + * \param mesh pointer to the mesh structure. + * \param lists pointer to the surfacic ball of the point we want to move (\a ip0). * \param l item of \a lists to process. * \param ip0 global index of point whose ball is passed. * \param ipa global idx of second vertex of previous bdy tria of the list (updated at end of tria processing). @@ -923,8 +923,8 @@ int MMG3D_curveEndingPts_chkEdg(MMG5_pMesh mesh,MMG5_int *lists,int l,MMG5_int i } /** - * \param mesh pointer toward the mesh structure. - * \param lists pointer toward the surfacic ball of the point. + * \param mesh pointer to the mesh structure. + * \param lists pointer to the surfacic ball of the point. * \param ilists size of the surfacic ball. * \param edgTag Type of edge on which we move (\ref MG_REF, \ref MG_NOM or \ref MG_GEO). * \param ip0 point that we want to move along curve. @@ -1031,10 +1031,10 @@ int MMG3D_curveEndingPts(MMG5_pMesh mesh,MMG5_int *lists,int ilists, } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param PROctree pointer toward the PROctree structure. - * \param listv pointer toward the volumic ball of the point. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param PROctree pointer to the PROctree structure. + * \param listv pointer to the volumic ball of the point. * \param ilistv size of the volumic ball. * \param improve force the new minimum element quality to be greater or equal * than 1.02 of the old minimum element quality. @@ -1123,7 +1123,7 @@ int MMG3D_movbdycurvept_chckAndUpdate(MMG5_pMesh mesh, MMG5_pSol met, } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param p0 point that we want to move. * \param ip0 global index of point \a p0. * \param ip1 First ending point of curve. @@ -1234,12 +1234,12 @@ int MMG3D_movbdycurvept_newPosForSimu(MMG5_pMesh mesh,MMG5_pPoint p0,MMG5_int ip /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param PROctree pointer toward the PROctree structure. - * \param listv pointer toward the volumic ball of the point. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param PROctree pointer to the PROctree structure. + * \param listv pointer to the volumic ball of the point. * \param ilistv size of the volumic ball. - * \param lists pointer toward the surfacic ball of the point. + * \param lists pointer to the surfacic ball of the point. * \param ilists size of the surfacic ball. * \param improve force the new minimum element quality to be greater or equal * than 1.02 of the old minimum element quality. @@ -1427,12 +1427,12 @@ int MMG3D_movbdycurvept_iso(MMG5_pMesh mesh, MMG5_pSol met, MMG3D_pPROctree PROc } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param PROctree pointer toward the PROctree structure. - * \param listv pointer toward the volumic ball of the point. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param PROctree pointer to the PROctree structure. + * \param listv pointer to the volumic ball of the point. * \param ilistv size of the volumic ball. - * \param lists pointer toward the surfacic ball of the point. + * \param lists pointer to the surfacic ball of the point. * \param ilists size of the surfacic ball. * \param improve force the new minimum element quality to be greater or equal * than 1.02 of the old minimum element quality. @@ -1450,12 +1450,12 @@ int MMG5_movbdyrefpt_iso(MMG5_pMesh mesh, MMG5_pSol met, MMG3D_pPROctree PROctre } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param PROctree pointer toward the PROctree structure. - * \param listv pointer toward the volumic ball of the point. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param PROctree pointer to the PROctree structure. + * \param listv pointer to the volumic ball of the point. * \param ilistv size of the volumic ball. - * \param lists pointer toward the surfacic ball of the point. + * \param lists pointer to the surfacic ball of the point. * \param ilists size of the surfacic ball. * \param improve force the new minimum element quality to be greater or equal * than 1.02 of the old minimum element quality. @@ -1474,10 +1474,10 @@ int MMG5_movbdynompt_iso(MMG5_pMesh mesh, MMG5_pSol met, MMG3D_pPROctree PROctre } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param PROctree pointer toward the PROctree structure. - * \param listv pointer toward the volumic ball of the point. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param PROctree pointer to the PROctree structure. + * \param listv pointer to the volumic ball of the point. * \param ilistv size of the volumic ball. * \param improve force the new minimum element quality to be greater or equal * than 1.02 of the old minimum element quality. @@ -1597,12 +1597,12 @@ int MMG5_movbdynomintpt_iso(MMG5_pMesh mesh,MMG5_pSol met, MMG3D_pPROctree PROct } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param PROctree pointer toward the PROctree structure. - * \param listv pointer toward the volumic ball of the point. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param PROctree pointer to the PROctree structure. + * \param listv pointer to the volumic ball of the point. * \param ilistv size of the volumic ball. - * \param lists pointer toward the surfacic ball of the point. + * \param lists pointer to the surfacic ball of the point. * \param ilists size of the surfacic ball. * \param improve force the new minimum element quality to be greater or equal * than 1.02 of the old minimum element quality. @@ -1618,8 +1618,8 @@ int MMG5_movbdyridpt_iso(MMG5_pMesh mesh, MMG5_pSol met, MMG3D_pPROctree PROctre } /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the metric structure. * \param k element index * \param ip local index of point * @@ -1737,8 +1737,8 @@ int MMG3D_movv_ani(MMG5_pMesh mesh,MMG5_pSol sol,MMG5_int k,int ib) { } /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the metric structure. * \param k tetra index. * \param ib local index of the point inside the tetra k. * \return 0 if fail, 1 if success. @@ -1865,8 +1865,8 @@ int MMG3D_movnormal_iso(MMG5_pMesh mesh,MMG5_pSol sol,MMG5_int k,int ib) { } /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the metric structure. * \param k element index * \param ip local index of point * diff --git a/src/mmg3d/optbdry_3d.c b/src/mmg3d/optbdry_3d.c index ada48ff46..7d446eb60 100644 --- a/src/mmg3d/optbdry_3d.c +++ b/src/mmg3d/optbdry_3d.c @@ -35,8 +35,8 @@ #include "mmg3dexterns_private.h" /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k index of a tetra * * \return 1 if we move one of the vertices, 0 otherwise. @@ -148,8 +148,8 @@ int MMG3D_movetetrapoints(MMG5_pMesh mesh,MMG5_pSol met,MMG3D_pPROctree PROctree } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k index of a tetra * \param i index of point to delete in tetra \a k. * @@ -206,9 +206,9 @@ int MMG3D_coledges(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int k,int i) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param PROctree pointer toward the PROctree structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param PROctree pointer to the PROctree structure. * \param k index of a tetra * \param i index of point to delete in tetra \a k. * @@ -246,9 +246,9 @@ int MMG3D_deletePoint(MMG5_pMesh mesh, MMG5_pSol met,MMG3D_pPROctree PROctree, } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param PROctree pointer toward the PROctree structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param PROctree pointer to the PROctree structure. * \param k index of a tetra * * \return 1 if success, 0 if fail. diff --git a/src/mmg3d/optlap_3d.c b/src/mmg3d/optlap_3d.c index c6f5bbff5..6b3abc268 100644 --- a/src/mmg3d/optlap_3d.c +++ b/src/mmg3d/optlap_3d.c @@ -36,8 +36,8 @@ #include "mmg3dexterns_private.h" /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure * \return 0 if fail, 1 otherwise. * * Laplacian/anti-laplacian over the mesh to improve its mean quality diff --git a/src/mmg3d/opttyp_3d.c b/src/mmg3d/opttyp_3d.c index f0aabbb6b..01d3bd13d 100644 --- a/src/mmg3d/opttyp_3d.c +++ b/src/mmg3d/opttyp_3d.c @@ -34,7 +34,7 @@ #include "inlined_functions_3d_private.h" /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param iel element index. * \param item bad entity. * \return -1 if fail, element type otherwise. @@ -315,9 +315,9 @@ static int MMG3D_typelt(MMG5_pMesh mesh,MMG5_int iel,int *item) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param PROctree pointer toward the PROctree structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param PROctree pointer to the PROctree structure. * \param k elt index. * \param iar index of edge to not try to swap. * \return -1 if fail, 0 if we don't swap anything, 1 otherwise. @@ -353,9 +353,9 @@ int MMG3D_swpItem(MMG5_pMesh mesh, MMG5_pSol met,MMG3D_pPROctree PROctree,MMG5_ } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param PROctree pointer toward the PROctree structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param PROctree pointer to the PROctree structure. * \param k elt index. * \param iar index of edge to not try to swap. * \return -1 if fail, 0 if we don't swap anything, 1 otherwise. @@ -380,9 +380,9 @@ int MMG3D_swpalmostall(MMG5_pMesh mesh, MMG5_pSol met,MMG3D_pPROctree PROctree, } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param PROctree pointer toward the PROctree structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param PROctree pointer to the PROctree structure. * \param k elt index. * \param iar index of edge to split. * \param OCRIT quality threshold. @@ -426,9 +426,9 @@ int MMG3D_splitItem(MMG5_pMesh mesh, MMG5_pSol met,MMG3D_pPROctree PROctree, } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param PROctree pointer toward the PROctree structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param PROctree pointer to the PROctree structure. * \param k elt index. * \param iar index of edge to not split. * \return 1 if success, 0 otherwise @@ -459,9 +459,9 @@ int MMG3D_splitalmostall(MMG5_pMesh mesh, MMG5_pSol met,MMG3D_pPROctree PROctre } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param PROctree pointer toward the PROctree structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param PROctree pointer to the PROctree structure. * \param testmark all the tets with a mark less than testmark will not be treated. * \return 0 if fail, number of improved elts otherwise. * diff --git a/src/mmg3d/quality_3d.c b/src/mmg3d/quality_3d.c index ba82544d6..40aa7732e 100644 --- a/src/mmg3d/quality_3d.c +++ b/src/mmg3d/quality_3d.c @@ -39,8 +39,8 @@ extern int8_t ddb; /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the meric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the meric structure. * \param metRidTyp metric storage (classic or special) * \return 1 if success, 0 if fail. * @@ -95,9 +95,9 @@ int MMG3D_tetraQual(MMG5_pMesh mesh, MMG5_pSol met,int8_t metRidTyp) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the meric structure. - * \param pt pointer toward a tetrahedra. + * \param mesh pointer to the mesh structure. + * \param met pointer to the meric structure. + * \param pt pointer to a tetrahedra. * \return The anisotropic quality of the tet or 0.0 if fail. * * Compute the quality of the tet pt with respect to the anisotropic metric \a @@ -198,8 +198,8 @@ inline double MMG5_caltet33_ani(MMG5_pMesh mesh,MMG5_pSol met,MMG5_pTetra pt) { /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param avlen average length (to fill). * \param lmin minimal length (to fill). * \param lmax max length (to fill). @@ -339,8 +339,8 @@ int MMG3D_computePrilen( MMG5_pMesh mesh, MMG5_pSol met, double* avlen, /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param metRidTyp Type of storage of ridges metrics: 0 for classic storage, * 1 for special storage. * \return 0 if fail, 1 otherwise. @@ -367,16 +367,16 @@ int MMG3D_prilen(MMG5_pMesh mesh, MMG5_pSol met, int8_t metRidTyp) { /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param ne pointer toward the number of used tetra (to fill). - * \param max pointer toward the maximal quality (normalized) to fill. - * \param avg pointer toward the average quality (normalized) to fill. - * \param min pointer toward the minimal quality (normalized) to fill. - * \param iel pointer toward the index of the worst tetra (to fill). + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param ne pointer to the number of used tetra (to fill). + * \param max pointer to the maximal quality (normalized) to fill. + * \param avg pointer to the average quality (normalized) to fill. + * \param min pointer to the minimal quality (normalized) to fill. + * \param iel pointer to the index of the worst tetra (to fill). * \param good number of good elements (to fill). * \param med number of elements with a quality greather than 0.5 (to fill). - * \param his pointer toward the mesh histogram (to fill). + * \param his pointer to the mesh histogram (to fill). * \param imprim verbosity level * * Compute the needed quality information in order to print the quality histogram @@ -456,7 +456,7 @@ void MMG3D_computeLESqua(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int *ne,double *max, * \param iel index of the worst tetra. * \param good number of good elements. * \param med number of elements with a quality greather than 0.5 - * \param his pointer toward the mesh histogram. + * \param his pointer to the mesh histogram. * \param nrid number of tetra with 4 ridge points if we want to warn the user. * \param optimLES 1 if we work in optimLES mode, 0 otherwise * \param imprim verbosity level @@ -491,7 +491,7 @@ int MMG3D_displayQualHisto(MMG5_int ne,double max,double avg,double min,MMG5_int * \param iel index of the worst tetra. * \param good number of good elements. * \param med number of elements with a quality greather than 0.5 - * \param his pointer toward the mesh histogram. + * \param his pointer to the mesh histogram. * \param nrid number of tetra with 4 ridge points if we want to warn the user. * \param optimLES 1 if we work in optimLES mode, 0 otherwise * \param imprim verbosity level @@ -550,16 +550,16 @@ int MMG3D_displayQualHisto_internal(MMG5_int ne,double max,double avg,double min } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param ne pointer toward the number of used tetra (to fill). - * \param max pointer toward the maximal quality (normalized) to fill. - * \param avg pointer toward the average quality (normalized) to fill. - * \param min pointer toward the minimal quality (normalized) to fill. - * \param iel pointer toward the index of the worst tetra (to fill). + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param ne pointer to the number of used tetra (to fill). + * \param max pointer to the maximal quality (normalized) to fill. + * \param avg pointer to the average quality (normalized) to fill. + * \param min pointer to the minimal quality (normalized) to fill. + * \param iel pointer to the index of the worst tetra (to fill). * \param good number of good elements (to fill). * \param med number of elements with a quality greather than 0.5 (to fill). - * \param his pointer toward the mesh histogram (to fill). + * \param his pointer to the mesh histogram (to fill). * \param imprim verbosity level * * Compute the needed quality information in order to print the quality histogram @@ -631,8 +631,8 @@ void MMG3D_computeInqua(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int *ne,double *max,d } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \return 0 if the worst element has a nul quality, 1 otherwise. * * Print histogram of mesh qualities for classic storage of metric at ridges. @@ -669,16 +669,16 @@ int MMG3D_inqua(MMG5_pMesh mesh,MMG5_pSol met) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param ne pointer toward the number of used tetra (to fill). - * \param max pointer toward the maximal quality (normalized) to fill. - * \param avg pointer toward the average quality (normalized) to fill. - * \param min pointer toward the minimal quality (normalized) to fill. - * \param iel pointer toward the index of the worst tetra (to fill). + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param ne pointer to the number of used tetra (to fill). + * \param max pointer to the maximal quality (normalized) to fill. + * \param avg pointer to the average quality (normalized) to fill. + * \param min pointer to the minimal quality (normalized) to fill. + * \param iel pointer to the index of the worst tetra (to fill). * \param good number of good elements (to fill). * \param med number of elements with a quality greather than 0.5 (to fill). - * \param his pointer toward the mesh histogram (to fill). + * \param his pointer to the mesh histogram (to fill). * \param nrid number of tetra with 4 ridge points if we want to warn the user * to fill. * \param imprim verbosity level @@ -763,8 +763,8 @@ void MMG3D_computeOutqua(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int *ne,double *max, } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * * \return 0 if the worst element has a nul quality, 1 otherwise. * @@ -803,8 +803,8 @@ int MMG3D_outqua(MMG5_pMesh mesh,MMG5_pSol met) { } /** - * \param mesh pointer toward the mesh. - * \param sol, pointer toward the sol structure. + * \param mesh pointer to the mesh. + * \param sol, pointer to the sol structure. * \param weightelt put weight on elts. * \param npcible estimation of the final number of nodes/ * diff --git a/src/mmg3d/split_3d.c b/src/mmg3d/split_3d.c index dbdf9029f..9357ba7d1 100644 --- a/src/mmg3d/split_3d.c +++ b/src/mmg3d/split_3d.c @@ -82,8 +82,8 @@ void MMG3D_split1_cfg(MMG5_int flag,uint8_t *tau,const uint8_t **taued) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k index of element to split. * \param vx \f$vx[i]\f$ is the index of the point to add on the edge \a i. * \return 0 if split leads to invalid situation, else 1. @@ -122,8 +122,8 @@ int MMG3D_split1_sim(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int k,MMG5_int vx[6]) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k index of element to split. * \param vx \f$vx[i]\f$ is the index of the point to add on the edge \a i. * \param metRidTyp metric storage (classic or special) @@ -244,7 +244,7 @@ int MMG5_split1(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int k,MMG5_int vx[6],int8_t m } /** - * \param mesh pointer toward the mesh structure + * \param mesh pointer to the mesh structure * \param start index of the tetra that we want to split * \param iface local index of the boundary face that we want to split * \param ia local index of the boundary edge that we want to split @@ -307,9 +307,9 @@ int MMG3D_normalDeviation(MMG5_pMesh mesh , MMG5_int start, int8_t iface, int } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric. - * \param list pointer toward the edge shell. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric. + * \param list pointer to the edge shell. * \param ret size of the edge shell. * \param ip new point index. * @@ -450,7 +450,7 @@ int MMG3D_simbulgept(MMG5_pMesh mesh,MMG5_pSol met,int64_t *list,int ret,MMG5_in } /** - * \param mesh pointer toward the mesh structure + * \param mesh pointer to the mesh structure * \param start index of the working tetra * \param iface local index of the boundary face of the tetra \a start * \param ia local index on face \a iface of the edge through which we seek @@ -497,10 +497,10 @@ int MMG3D_normalAdjaTri(MMG5_pMesh mesh , MMG5_int start, int8_t iface, int ia, } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param ip index of new point. * \param k position of the tetra to split in the shell of edge. - * \param list pointer toward the shell of edge. + * \param list pointer to the shell of edge. * \param newtet list of indices of created tetra * \param tau vertices permutation * @@ -598,9 +598,9 @@ int MMG5_split1b_eltspl(MMG5_pMesh mesh,MMG5_int ip,MMG5_int k,int64_t *list,MMG } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param list pointer toward the shell of edge. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param list pointer to the shell of edge. * \param ret size of the shell of edge. * \param ip idex of new point. * \param cas flag to watch the length of the new edges. @@ -1057,8 +1057,8 @@ void MMG3D_split2sf_cfg(MMG5_int flag,MMG5_int v[4],uint8_t *tau,const uint8_t * } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k index of element to split. * \param vx \f$vx[i]\f$ is the index of the point to add on the edge \a i. * @@ -1117,7 +1117,7 @@ int MMG3D_split2sf_sim(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int k,MMG5_int vx[6]){ } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param newtet list of indices of the new tetra. * \param ne number of tetra in the list. * \param pt list of tetra. @@ -1170,8 +1170,8 @@ int MMG3D_crea_newTetra(MMG5_pMesh mesh,const int ne,MMG5_int *newtet, } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param ne number of tetra in the list * \param newtet list of tetra indices * \param pt list of tetra @@ -1209,8 +1209,8 @@ void MMG3D_update_qual(MMG5_pMesh mesh,MMG5_pSol met,const int ne, } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k index of element to split. * \param vx \f$vx[i]\f$ is the index of the point to add on the edge \a i. * \param metRidTyp metric storage (classic or special) @@ -1228,8 +1228,8 @@ int MMG5_split2sf(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int k,MMG5_int vx[6],int8_t } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k index of element to split. * \param vx \f$vx[i]\f$ is the index of the point to add on the edge \a i. * \param vGlobNum vertices indices of the tetra k (global node indices if called from ParMmg in ls mode). @@ -1375,8 +1375,8 @@ int MMG5_split2sf_globNum(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int k,MMG5_int vx[6 } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k index of element to split. * \param vx \f$vx[i]\f$ is the index of the point to add on the edge \a i. * @@ -1436,8 +1436,8 @@ int MMG3D_split2_sim(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int k,MMG5_int vx[6]){ } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k index of element to split. * \param vx \f$vx[i]\f$ is the index of the point to add on the edge \a i. * \param metRidTyp metric storage (classic or special) @@ -1648,8 +1648,8 @@ int MMG3D_split3_sim(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int k,MMG5_int vx[6]) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k index of element to split. * \param vx \f$vx[i]\f$ is the index of the point to add on the edge \a i. * \param metRidTyp metric storage (classic or special) @@ -1857,8 +1857,8 @@ void MMG3D_split3cone_cfg(MMG5_int flag,MMG5_int v[4],uint8_t tau[4], } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k index of element to split. * \param vx \f$vx[i]\f$ is the index of the point to add on the edge \a i. * @@ -1996,8 +1996,8 @@ int MMG3D_split3cone_sim(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int k,MMG5_int vx[6] } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k index of element to split. * \param vx \f$vx[i]\f$ is the index of the point to add on the edge \a i. * \param metRidTyp metric storage (classic or special) @@ -2015,8 +2015,8 @@ int MMG5_split3cone(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int k,MMG5_int vx[6],int8 } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k index of element to split. * \param vx \f$vx[i]\f$ is the index of the point to add on the edge \a i. * \param vGlobNum vertices indices of the tetra k (global node indices if called from ParMmg in ls mode). @@ -2452,8 +2452,8 @@ void MMG3D_split3op_cfg(MMG5_pTetra pt,MMG5_int vx[6],uint8_t tau[4], } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k index of element to split. * \param vx \f$vx[i]\f$ is the index of the point to add on the edge \a i. * @@ -2583,8 +2583,8 @@ int MMG3D_split3op_sim(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int k,MMG5_int vx[6]) } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k index of element to split. * \param vx \f$vx[i]\f$ is the index of the point to add on the edge \a i. * \param metRidTyp metric storage (classic or special) @@ -2973,8 +2973,8 @@ int MMG5_split3op(MMG5_pMesh mesh, MMG5_pSol met, MMG5_int k, MMG5_int vx[6],int /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k tetra index. * \param metRidTyp metric storage (classic or special) * \return 0 if fail, index of created point otherwise (\a ib) @@ -3261,8 +3261,8 @@ void MMG3D_split4sf_cfg(MMG5_pTetra pt,MMG5_int vx[6],uint8_t tau[4], } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k index of element to split. * \param vx \f$vx[i]\f$ is the index of the point to add on the edge \a i. * @@ -3363,8 +3363,8 @@ int MMG3D_split4sf_sim(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int k,MMG5_int vx[6]) } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k index of element to split. * \param vx \f$vx[i]\f$ is the index of the point to add on the edge \a i. * \param metRidTyp metric storage (classic or special) @@ -3603,8 +3603,8 @@ void MMG3D_split4op_cfg(MMG5_int flag,MMG5_int v[4],uint8_t tau[4], } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k index of element to split. * \param vx \f$vx[i]\f$ is the index of the point to add on the edge \a i. * @@ -3723,8 +3723,8 @@ int MMG3D_split4op_sim(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int k,MMG5_int vx[6]) } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k index of element to split. * \param vx \f$vx[i]\f$ is the index of the point to add on the edge \a i. * \param metRidTyp metric storage (classic or special) @@ -3742,8 +3742,8 @@ int MMG5_split4op(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int k,MMG5_int vx[6],int8_t } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k index of element to split. * \param vx \f$vx[i]\f$ is the index of the point to add on the edge \a i. * \param vGlobNum vertices indices of the tetra k (global node indices if called from ParMmg in ls mode). @@ -4023,8 +4023,8 @@ void MMG3D_split5_cfg(MMG5_pTetra pt,MMG5_int vx[6],uint8_t tau[4], } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k index of element to split. * \param vx \f$vx[i]\f$ is the index of the point to add on the edge \a i. * @@ -4114,8 +4114,8 @@ int MMG3D_split5_sim(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int k,MMG5_int vx[6]) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k index of element to split. * \param vx \f$vx[i]\f$ is the index of the point to add on the edge \a i. * \param metRidTyp metric storage (classic or special) @@ -4320,8 +4320,8 @@ int MMG5_split5(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int k,MMG5_int vx[6],int8_t m } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k index of element to split. * \param vx \f$vx[i]\f$ is the index of the point to add on the edge \a i. * @@ -4388,8 +4388,8 @@ int MMG3D_split6_sim(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int k,MMG5_int vx[6]) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k index of element to split. * \param vx \f$vx[i]\f$ is the index of the point to add on the edge \a i. * \param metRidTyp metric storage (classic or special) @@ -4760,10 +4760,10 @@ int MMG5_split6(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int k,MMG5_int vx[6],int8_t m /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param ip index of new point. - * \param list pointer toward the shell of edge. + * \param list pointer to the shell of edge. * \param ret size of the shell of edge. * \param crit quality threshold. * \return 0 if fail, 1 otherwise. @@ -4816,8 +4816,8 @@ int MMG3D_chksplit(MMG5_pMesh mesh, MMG5_pSol met,MMG5_int ip, } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param iel tetra index * \param iar edge index of iel * \param crit quality threshold. diff --git a/src/mmg3d/swap_3d.c b/src/mmg3d/swap_3d.c index 6bec02880..3579fa230 100644 --- a/src/mmg3d/swap_3d.c +++ b/src/mmg3d/swap_3d.c @@ -39,10 +39,10 @@ extern int8_t ddb; /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param list pointer toward the shell of the edge. - * \param ilist pointer toward the size of the shell of the edge. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param list pointer to the shell of the edge. + * \param ilist pointer to the size of the shell of the edge. * \param it1 first element of the open shell. * \param it2 last element of the open shell. * \param typchk type of checking permformed for edge length (hmin or LSHORT @@ -449,13 +449,13 @@ int MMG5_chkswpbdy(MMG5_pMesh mesh, MMG5_pSol met, int64_t *list,int ilist, } /** - * \param mesh pointer toward the mesh structure - * \param met pointer toward the solution structure - * \param list pointer toward the shell of the edge + * \param mesh pointer to the mesh structure + * \param met pointer to the solution structure + * \param list pointer to the shell of the edge * \param ret dobble of the number of tetrahedra in the shell * \param it1 boundary face carrying the beforehand tested terminal * point for collapse - * \param PROctree pointer toward the PROctree structure in Delaunay mode, + * \param PROctree pointer to the PROctree structure in Delaunay mode, * NULL pointer in pattern mode. * \param typchk type of checking permformed for edge length (hmin or LSHORT * criterion). @@ -583,8 +583,8 @@ int MMG5_swpbdy(MMG5_pMesh mesh,MMG5_pSol met,int64_t *list,int ret,MMG5_int it1 } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the sol structure. * \param k index of the tetrahedron with multiple boundary faces (to be swapped). * \param metRidTyp metric storage (classic or special) * \param ifac face of the tetra \a k that give the best results for the swap23 diff --git a/src/mmg3d/swapgen_3d.c b/src/mmg3d/swapgen_3d.c index 26329b7bc..cac3926df 100644 --- a/src/mmg3d/swapgen_3d.c +++ b/src/mmg3d/swapgen_3d.c @@ -37,8 +37,8 @@ #include "mmg3dexterns_private.h" /** - * \param mesh pointer toward the mesh structure - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure + * \param met pointer to the metric structure. * \param start tetrahedra in which the swap should be performed * \param ia edge that we want to swap * \param ilist pointer to store the size of the shell of the edge @@ -253,13 +253,13 @@ MMG5_int MMG5_chkswpgen(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int start,int ia, } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the sol structure. * \param nconf configuration. * \param ilist number of tetrahedra in the shell of the edge that we want * to swap. - * \param list pointer toward the shell of the edge that we want to swap. - * \param PROctree pointer toward the PROctree structure in Delaunay mode, + * \param list pointer to the shell of the edge that we want to swap. + * \param PROctree pointer to the PROctree structure in Delaunay mode, * NULL pointer in pattern mode. * \param typchk type of checking permformed for edge length (hmin or LSHORT * criterion). diff --git a/src/mmg3d/tools_3d.c b/src/mmg3d/tools_3d.c index 2ccd81503..d535163d3 100644 --- a/src/mmg3d/tools_3d.c +++ b/src/mmg3d/tools_3d.c @@ -1004,15 +1004,15 @@ void MMG5_printTetra(MMG5_pMesh mesh,char* fileName) { /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param ip global index of point in which we want to compute the local parameters - * \param listv pointer toward the ball of \a ip + * \param listv pointer to the ball of \a ip * \param ilistv number of tetra in the ball of \a ip - * \param lists pointer toward the surface ball of \a ip + * \param lists pointer to the surface ball of \a ip * \param ilists number of tetra in the surface ball of \a ip - * \param hausd_ip pointer toward the local hausdorff parameter to compute - * \param hmin_ip pointer toward the local minimal edge size to compute - * \param hmax_ip pointer toward the local maximal edge size to compute + * \param hausd_ip pointer to the local hausdorff parameter to compute + * \param hmin_ip pointer to the local minimal edge size to compute + * \param hmax_ip pointer to the local maximal edge size to compute * * \return 1 if success, 0 if fail * @@ -1126,14 +1126,14 @@ int MMG3D_localParamReg(MMG5_pMesh mesh,MMG5_int ip,int64_t *listv,int ilistv, } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param iel index of tetra in which we work * \param iface index of face in \a iel * \param ia index of edge in \a iel along which we want to compute the local * parameters - * \param hausd_ip pointer toward the local hausdorff parameter to compute - * \param hmin_ip pointer toward the local minimal edge size to compute - * \param hmax_ip pointer toward the local maximal edge size to compute + * \param hausd_ip pointer to the local hausdorff parameter to compute + * \param hmin_ip pointer to the local minimal edge size to compute + * \param hmax_ip pointer to the local maximal edge size to compute * * \return 1 if success, 0 if fail * @@ -1279,7 +1279,7 @@ int MMG3D_localParamNm(MMG5_pMesh mesh,MMG5_int iel,int iface,int ia, } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * * Mark the mesh vertices that belong to triangles or quadrangles as used (for * Mmgs or Mmg2d). @@ -1332,7 +1332,7 @@ void MMG3D_mark_usedVertices ( MMG5_pMesh mesh ) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param nsd subdomain index. * * Remove tetra that do not belong to subdomain of index \a nsd @@ -1382,7 +1382,7 @@ void MMG3D_keep_subdomainElts ( MMG5_pMesh mesh, int nsd ) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param nsd index of subdomain to keep. * * Keep only subdomain of index \a nsd and remove other subdomains. diff --git a/src/mmg3d/variadic_3d.c b/src/mmg3d/variadic_3d.c index 1254ab089..42fa810d9 100644 --- a/src/mmg3d/variadic_3d.c +++ b/src/mmg3d/variadic_3d.c @@ -43,10 +43,10 @@ #include "mmg3dexterns_private.h" /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward a sol structure (metric). - * \param ls pointer toward the level-set (in ls-mode). - * \param disp pointer toward a sol structure (displacement). + * \param mesh pointer to the mesh structure. + * \param met pointer to a sol structure (metric). + * \param ls pointer to the level-set (in ls-mode). + * \param disp pointer to a sol structure (displacement). * * \return 1 if success, 0 if fail. * @@ -84,10 +84,10 @@ int MMG3D_Alloc_mesh(MMG5_pMesh *mesh, MMG5_pSol *met, MMG5_pSol *ls, MMG5_pSol return 1; } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward a sol structure (metric). - * \param ls pointer toward the level-set (in ls-mode). - * \param disp pointer toward a sol structure (displacement). + * \param mesh pointer to the mesh structure. + * \param met pointer to a sol structure (metric). + * \param ls pointer to the level-set (in ls-mode). + * \param disp pointer to a sol structure (displacement). * * Initialization of mesh and solution structures to their default * values (default names, versions, dimensions...). @@ -153,11 +153,11 @@ void MMG3D_Init_woalloc_mesh(MMG5_pMesh mesh, MMG5_pSol *met,MMG5_pSol *ls, MMG5 * structure must follow one of the MMG5_ARG* preprocessor variable that allow * to identify it. * - * \a argptr contains at least a pointer toward a \a MMG5_pMesh structure + * \a argptr contains at least a pointer to a \a MMG5_pMesh structure * (that will contain the mesh and identified by the MMG5_ARG_ppMesh keyword) * * To call the \a MMG3D_mmg3dlib function, you must also provide - * a pointer toward a \a MMG5_pSol structure (that will contain the ouput + * a pointer to a \a MMG5_pSol structure (that will contain the ouput * metric (and the input one, if provided) and identified by the MMG5_ARG_ppMet * keyword). * @@ -166,7 +166,7 @@ void MMG3D_Init_woalloc_mesh(MMG5_pMesh mesh, MMG5_pSol *met,MMG5_pSol *ls, MMG5 * identified by the MMG5_ARG_ppLs keyword). * * To call the \a MMG3D_mmg3dmov library, you must also provide a - * pointer toward a \a MMG5_pSol structure storing the displacement (and + * pointer to a \a MMG5_pSol structure storing the displacement (and * identified by the MMG5_ARG_ppDisp keyword). * * \return 1 if success, 0 if fail @@ -234,11 +234,11 @@ int MMG3D_Init_mesh_var( va_list argptr ) { * structure must follow one of the MMG5_ARG* preprocessor variable that allow * to identify it. * - * \a argptr contains at least a pointer toward a \a MMG5_pMesh structure + * \a argptr contains at least a pointer to a \a MMG5_pMesh structure * (that will contain the mesh and identified by the MMG5_ARG_ppMesh keyword) * * To call the \a MMG3D_mmg3dlib function, you must also provide - * a pointer toward a \a MMG5_pSol structure (that will contain the ouput + * a pointer to a \a MMG5_pSol structure (that will contain the ouput * metric (and the input one, if provided) and identified by the MMG5_ARG_ppMet * keyword). * @@ -247,7 +247,7 @@ int MMG3D_Init_mesh_var( va_list argptr ) { * identified by the MMG5_ARG_ppLs keyword). * * To call the \a MMG3D_mmg3dmov library, you must also provide a - * pointer toward a \a MMG5_pSol structure storing the displacement (and + * pointer to a \a MMG5_pSol structure storing the displacement (and * identified by the MMG5_ARG_ppDisp keyword). * * \return 0 if fail, 1 if success @@ -349,9 +349,9 @@ int MMG3D_Free_all_var(va_list argptr) } /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward a solution / level-set. - * \param sol pointer toward a displacement. + * \param mesh pointer to the mesh structure. + * \param sol pointer to a solution / level-set. + * \param sol pointer to a displacement. * * Free mesh arrays. * @@ -421,11 +421,11 @@ void MMG3D_Free_arrays(MMG5_pMesh *mesh,MMG5_pSol *sol,MMG5_pSol *ls, * structure must follow one of the MMG5_ARG* preprocessor variable that allow * to identify it. * - * \a argptr contains at least a pointer toward a \a MMG5_pMesh structure + * \a argptr contains at least a pointer to a \a MMG5_pMesh structure * (that will contain the mesh and identified by the MMG5_ARG_ppMesh keyword) * * To call the \a MMG3D_mmg3dlib function, you must also provide - * a pointer toward a \a MMG5_pSol structure (that will contain the ouput + * a pointer to a \a MMG5_pSol structure (that will contain the ouput * metric (and the input one, if provided) and identified by the MMG5_ARG_ppMet * keyword). * @@ -434,7 +434,7 @@ void MMG3D_Free_arrays(MMG5_pMesh *mesh,MMG5_pSol *sol,MMG5_pSol *ls, * identified by the MMG5_ARG_ppLs keyword). * * To call the \a MMG3D_mmg3dmov library, you must also provide a - * pointer toward a \a MMG5_pSol structure storing the displacement (and + * pointer to a \a MMG5_pSol structure storing the displacement (and * identified by the MMG5_ARG_ppDisp keyword). * * \return 0 if fail, 1 if success @@ -519,11 +519,11 @@ int MMG3D_Free_structures_var(va_list argptr) * name. Each structure must follow one of the \a MMG5_ARG* preprocessor * variable that allow to identify it. * - * \a argptr contains at least a pointer toward a \a MMG5_pMesh structure + * \a argptr contains at least a pointer to a \a MMG5_pMesh structure * (that will contain the mesh and identified by the MMG5_ARG_ppMesh keyword) * * To call the \a MMG3D_mmg3dlib function, you must also provide - * a pointer toward a \a MMG5_pSol structure (that will contain the ouput + * a pointer to a \a MMG5_pSol structure (that will contain the ouput * metric (and the input one, if provided) and identified by the MMG5_ARG_ppMet * keyword). * @@ -532,7 +532,7 @@ int MMG3D_Free_structures_var(va_list argptr) * identified by the MMG5_ARG_ppLs keyword). * * To call the \a MMG3D_mmg3dmov library, you must also provide a - * pointer toward a \a MMG5_pSol structure storing the displacement (and + * pointer to a \a MMG5_pSol structure storing the displacement (and * identified by the MMG5_ARG_ppDisp keyword). * * \return 0 if fail, 1 if success diff --git a/src/mmg3d/velextls_3d.c b/src/mmg3d/velextls_3d.c index 959b9e4af..4414ddf78 100644 --- a/src/mmg3d/velextls_3d.c +++ b/src/mmg3d/velextls_3d.c @@ -42,10 +42,10 @@ #define _LS_MU 8.2e5 /** - * \param mesh pointer toward the mesh - * \param disp pointer toward the displacement - * \param lsst pointer toward the elastic structure (mesh + sol + info) - * \param npfin pointer toward the final number of points in the packed mesh + * \param mesh pointer to the mesh + * \param disp pointer to the displacement + * \param lsst pointer to the elastic structure (mesh + sol + info) + * \param npfin pointer to the final number of points in the packed mesh * for the elasticity call * * \return invperm array of the permutation (vertices) from the submesh (given @@ -354,10 +354,10 @@ MMG5_int* MMG5_packLS(MMG5_pMesh mesh,MMG5_pSol disp,LSst *lsst,MMG5_int *npfin) } /** - * \param mesh pointer toward the mesh - * \param disp pointer toward the displacement - * \param lsst pointer toward the elastic structure (mesh + sol + info) - * \param npf pointer toward the number of points in the submesh + * \param mesh pointer to the mesh + * \param disp pointer to the displacement + * \param lsst pointer to the elastic structure (mesh + sol + info) + * \param npf pointer to the number of points in the submesh * \param invperm array of the permutation from the submesh toward * the global one * @@ -389,8 +389,8 @@ int MMG5_unpackLS(MMG5_pMesh mesh,MMG5_pSol disp,LSst *lsst,MMG5_int npf,MMG5_in } /** - * \param mesh pointer toward the mesh. - * \param disp pointer toward the displacement. + * \param mesh pointer to the mesh. + * \param disp pointer to the displacement. * * \return 0 if fail, 1 if success. * diff --git a/src/mmg3d/zaldy_3d.c b/src/mmg3d/zaldy_3d.c index 0d72b325c..63976e5b0 100644 --- a/src/mmg3d/zaldy_3d.c +++ b/src/mmg3d/zaldy_3d.c @@ -111,7 +111,7 @@ MMG5_int MMG3D_newElt(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh + * \param mesh pointer to the mesh * \param iel index of the element to delete * * \return 1 if success, 0 if fail @@ -141,7 +141,7 @@ int MMG3D_delElt(MMG5_pMesh mesh,MMG5_int iel) { } /** - * \param mesh pointer toward the mesh structure + * \param mesh pointer to the mesh structure * * \return 0 if fail, 1 otherwise * @@ -163,7 +163,7 @@ int MMG3D_memOption_memSet(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh structure + * \param mesh pointer to the mesh structure * * \return 0 if fail, 1 otherwise * @@ -261,7 +261,7 @@ int MMG3D_memOption_memRepartition(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh structure + * \param mesh pointer to the mesh structure * * \return 0 if fail, 1 otherwise * @@ -278,7 +278,7 @@ int MMG3D_memOption(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * * \return 0 if failed, 1 otherwise. * @@ -336,7 +336,7 @@ int MMG3D_setMeshSize_alloc( MMG5_pMesh mesh ) { } /** - * \param mesh pointer toward the mesh + * \param mesh pointer to the mesh * * \return 1 if success, 0 if fail * @@ -351,7 +351,7 @@ int MMG3D_zaldy(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * * Free xtetra structure. * @@ -370,7 +370,7 @@ void MMG5_freeXTets(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * * Free xprism structure. * diff --git a/src/mmgs/analys_s.c b/src/mmgs/analys_s.c index 372afdc22..1aa0a68cd 100644 --- a/src/mmgs/analys_s.c +++ b/src/mmgs/analys_s.c @@ -37,7 +37,7 @@ #include "mmgcommon_private.h" /** - * \param mesh pointer toward the mesh + * \param mesh pointer to the mesh * * \return 1 if success, 0 if fail * @@ -244,7 +244,7 @@ int MMGS_setadj(MMG5_pMesh mesh){ } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * * \return 1 if succeed, 0 if fail * @@ -436,7 +436,7 @@ static void nmpoints(MMG5_pMesh mesh) { /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * * \return 1 if succeed, 0 if fail * @@ -486,7 +486,7 @@ static int setdhd(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * * \return 1 if succeed, 0 if fail * @@ -584,7 +584,7 @@ static int MMG5_singul(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * * \return 1 if succeed, 0 if fail * @@ -739,8 +739,8 @@ static int norver(MMG5_pMesh mesh) { } /** - * \param mesh pointer towards the mesh - * \param pt pointer towards current triangle + * \param mesh pointer tos the mesh + * \param pt pointer tos current triangle * \param k number of current point * \param c newly computed coordinates (giving negative area) * \param n normal of triangle before regularization @@ -807,7 +807,7 @@ static inline int MMGS_dichotomy(MMG5_pMesh mesh, MMG5_pTria pt, MMG5_int k, dou } /** - * \param mesh pointer toward a MMG5 mesh structure. + * \param mesh pointer to a MMG5 mesh structure. * \return 0 if fail, 1 otherwise. * * Regularization procedure for vertices coordinates, @@ -1032,7 +1032,7 @@ int MMGS_remDup(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * * \return 1 if succeed, 0 if fail * diff --git a/src/mmgs/anisomovpt_s.c b/src/mmgs/anisomovpt_s.c index 932315cb3..57d8164bf 100644 --- a/src/mmgs/anisomovpt_s.c +++ b/src/mmgs/anisomovpt_s.c @@ -37,8 +37,8 @@ #include "mmgexterns_private.h" /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param list ball of point. * \param ilist size of the point ball. * \return 0 if fail, 1 otherwise. diff --git a/src/mmgs/anisosiz_s.c b/src/mmgs/anisosiz_s.c index b501af2f0..0e0222e92 100644 --- a/src/mmgs/anisosiz_s.c +++ b/src/mmgs/anisosiz_s.c @@ -40,8 +40,8 @@ #include "mmgexterns_private.h" /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param it index of the triangle in which we work. * \param ip index of the point on which we want to compute the metric in \a it. * \return 1 if success, 0 otherwise. @@ -149,8 +149,8 @@ static int MMG5_defmetsin(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int it,int ip) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param it index of the triangle in which we work. * \param ip index of the point on which we want to compute the metric in \a it. * \return 1 if success, 0 otherwise. @@ -339,8 +339,8 @@ static int MMG5_defmetrid(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int it,int ip) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param it index of the triangle in which we work. * \param ip index of the point on which we want to compute the metric in \a it. * \return 1 if success, 0 otherwise. @@ -512,7 +512,7 @@ static int MMG5_defmetref(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int it,int ip) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param p0 starting point * \param list ball of \a p0 * \param ilist number of tria in the ball of \a p0 @@ -580,8 +580,8 @@ int MMGS_surfballRotation(MMG5_pMesh mesh,MMG5_pPoint p0,MMG5_int *list,int ilis } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param it index of the triangle in which we work. * \param ip index of the point on which we want to compute the metric in \a it. * \return 1 if success, 0 otherwise. @@ -676,8 +676,8 @@ static int MMG5_defmetreg(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int it,int ip) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param np global index of vertex in which we intersect the metrics. * \param me physical metric at point \a np. * \return 0 if fail, 1 otherwise. @@ -710,8 +710,8 @@ int MMGS_intextmet(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int np,double me[6]) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric stucture. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric stucture. * \return 0 if fail, 1 otherwise. * * Define size at points by intersecting the surfacic metric and the @@ -824,8 +824,8 @@ int MMGS_defsiz_ani(MMG5_pMesh mesh,MMG5_pSol met) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \return 1 * * diff --git a/src/mmgs/bezier_s.c b/src/mmgs/bezier_s.c index 1509498c7..0868b0b80 100644 --- a/src/mmgs/bezier_s.c +++ b/src/mmgs/bezier_s.c @@ -38,9 +38,9 @@ extern int8_t ddb; /** - * \param mesh pointer toward the mesh structure. - * \param pt pointer toward the triangle structure. - * \param pb pointer toward the computed Bezier structure. + * \param mesh pointer to the mesh structure. + * \param pt pointer to the triangle structure. + * \param pb pointer to the computed Bezier structure. * \param ori triangle orientation (unused but here for compatibility * with the MMG5_bezierCP interface). * \return 1. @@ -194,7 +194,7 @@ int MMG5_mmgsBezierCP(MMG5_pMesh mesh,MMG5_Tria *pt,MMG5_pBezier pb, } /** - * \param pb pointer toward the Bezier structure. + * \param pb pointer to the Bezier structure. * \param uv coordinates of the point in the parametric space. * \param o computed coordinates of the point in the real space. * \param no computed normal. diff --git a/src/mmgs/boulep_s.c b/src/mmgs/boulep_s.c index 716388c0b..7003a82f1 100644 --- a/src/mmgs/boulep_s.c +++ b/src/mmgs/boulep_s.c @@ -36,11 +36,11 @@ #include "libmmgs_private.h" /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param start index of tetra to start to compute the ball. * \param ip index of point in tetra \a start for which we want to compute * the ball. - * \param list pointer toward the computed ball of point. + * \param list pointer to the computed ball of point. * * \return size of list if success, -size if overflow, 0 if cfg is non-manifold. * @@ -180,14 +180,14 @@ int boulechknm(MMG5_pMesh mesh,MMG5_int start,int ip,MMG5_int *list) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param start index of the starting triangle. * \param ip index of the looked ridge point. - * \param il1 pointer toward the first ball size. - * \param l1 pointer toward the first computed ball (associated to \a n1's + * \param il1 pointer to the first ball size. + * \param l1 pointer to the first computed ball (associated to \a n1's * side). - * \param il2 pointer toward the second ball size. - * \param l2 pointer toward the second computed ball (associated to \a n2's + * \param il2 pointer to the second ball size. + * \param l2 pointer to the second computed ball (associated to \a n2's * side). * \param global ip0 index of the first extremity of the ridge. * \param global ip1 index of the second extremity of the ridge. diff --git a/src/mmgs/chkmsh_s.c b/src/mmgs/chkmsh_s.c index 4dbd8d3e9..58be6b8b4 100644 --- a/src/mmgs/chkmsh_s.c +++ b/src/mmgs/chkmsh_s.c @@ -37,7 +37,7 @@ /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param severe level of performed check * \param base unused argument. * \return 0 if fail, 1 if success. @@ -231,7 +231,7 @@ int MMG5_mmgsChkmsh(MMG5_pMesh mesh,int severe,MMG5_int base) { } /** - * \param mesh pointer toward the mesh + * \param mesh pointer to the mesh * * \return 1 if success, 0 if fail. * diff --git a/src/mmgs/colver_s.c b/src/mmgs/colver_s.c index 9df97831c..2637f4ff5 100644 --- a/src/mmgs/colver_s.c +++ b/src/mmgs/colver_s.c @@ -38,16 +38,16 @@ #include "inlined_functions_private.h" /** - * \param mesh pointer toward the mesh - * \param met pointer toward the metric + * \param mesh pointer to the mesh + * \param met pointer to the metric * \param k index of the element in wich we collapse * \param i index of the edge to collapse - * \param list pointer toward the ball of point + * \param list pointer to the ball of point * \param typchk type of check to perform - * \param MMGS_lenEdg pointer toward the suitable fct to compute edge lengths + * \param MMGS_lenEdg pointer to the suitable fct to compute edge lengths * depending on presence of input metric, metric type (iso/aniso) and \a typchk * value (i.e. stage of adaptation) - * \param MMGS_caltri pointer toward the suitable fct to compute tria quality + * \param MMGS_caltri pointer to the suitable fct to compute tria quality * depending on presence of input metric, metric type (iso/aniso) and \a typchk * value (i.e. stage of adaptation) * @@ -359,8 +359,8 @@ int colver(MMG5_pMesh mesh,MMG5_int *list,int ilist) { /** - * \param mesh pointer toward the mesh structure. - * \param list pointer toward the ball of the point to collapse. + * \param mesh pointer to the mesh structure. + * \param list pointer to the ball of the point to collapse. * \return 1 if success, 0 if fail. * * Collapse edge \f$list[0]\%3\f$ in tet \f$list[0]/3\f$ (\f$ ip->i1\f$ ) for a diff --git a/src/mmgs/gentools_s.c b/src/mmgs/gentools_s.c index 1d07ddf50..05589a552 100644 --- a/src/mmgs/gentools_s.c +++ b/src/mmgs/gentools_s.c @@ -49,7 +49,7 @@ int delref(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh + * \param mesh pointer to the mesh * \param start index of the tetra from which we start * \param ref reference to set * \param putreq 1 if boundary edges must be set to required @@ -152,7 +152,7 @@ MMG5_int MMGS_indPt(MMG5_pMesh mesh, MMG5_int kp) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param nsd index of subdomain to keep. * * Keep only subdomain of index \a nsd and remove other subdomains. diff --git a/src/mmgs/hash_s.c b/src/mmgs/hash_s.c index 64b6eed2c..fce1a2567 100644 --- a/src/mmgs/hash_s.c +++ b/src/mmgs/hash_s.c @@ -36,7 +36,7 @@ #include "libmmgs_private.h" /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \return 1 if success, 0 if fail. * * tria packing @@ -68,7 +68,7 @@ static int paktri(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \return 1 if success, 0 if fail. * * Create adjacency table. @@ -97,7 +97,7 @@ int MMGS_hashTria(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \return 1 if success, 0. * * Copy the properties (ref and tag) of the declared edges to the triangles, @@ -159,7 +159,7 @@ int MMGS_assignEdge(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \return 1 if success, 0. * * Copy the edge tags stored in triangles in the other triangles sharing the diff --git a/src/mmgs/intmet_s.c b/src/mmgs/intmet_s.c index 9203c0f29..36e0a4b41 100644 --- a/src/mmgs/intmet_s.c +++ b/src/mmgs/intmet_s.c @@ -41,8 +41,8 @@ extern int8_t ddb; /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k element index. * \param i local index of edge in \a k. * \param s interpolation parameter. @@ -63,8 +63,8 @@ int intregmet(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int k,int8_t i,double s,double } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k triangle in which we interpole the metrics. * \param i edge along which we interpole the metrics. * \param ip index of point in which we compute the interpolated metric. @@ -89,8 +89,8 @@ int intmet_iso(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int k,int8_t i,MMG5_int ip,dou } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k element index. * \param i local index of edge in \a k. * \param ip global index of the new point in which we want to compute the metric. @@ -129,8 +129,8 @@ int intmet_ani(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int k,int8_t i,MMG5_int ip,dou } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k element index. * \param i local index of edge in \a k. * \param ip global index of the new point in which we want to compute the metric. diff --git a/src/mmgs/isosiz_s.c b/src/mmgs/isosiz_s.c index c5ba29ca8..fcfce63d9 100644 --- a/src/mmgs/isosiz_s.c +++ b/src/mmgs/isosiz_s.c @@ -42,8 +42,8 @@ #define MAXLEN 1.0e+3 /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param hash edge hashtable. * \param pt tria to process. * \param i index of the edge of the tria \a pt that we process. @@ -76,8 +76,8 @@ int MMGS_sum_reqEdgeLengthsAtPoint(MMG5_pMesh mesh,MMG5_pSol met,MMG5_Hash *hash } /** - * \param mesh pointer toward the mesh - * \param met pointer toward the metric + * \param mesh pointer to the mesh + * \param met pointer to the metric * \param ismet 1 if user provided metric * * \return 0 if fail, 1 otherwise @@ -130,8 +130,8 @@ int MMGS_set_metricAtPointsOnReqEdges ( MMG5_pMesh mesh,MMG5_pSol met,int8_t ism } /** - * \param mesh pointer toward the mesh - * \param met pointer toward the metric + * \param mesh pointer to the mesh + * \param met pointer to the metric * * \return 1 if success, 0 if fail * diff --git a/src/mmgs/libmmgs.c b/src/mmgs/libmmgs.c index 5d8a4febb..e86930d19 100644 --- a/src/mmgs/libmmgs.c +++ b/src/mmgs/libmmgs.c @@ -81,9 +81,9 @@ void MMGS_Free_topoTables(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh structure (unused). - * \param sol pointer toward a solution structure. - * \param met pointer toward the solution (metric) structure. + * \param mesh pointer to the mesh structure (unused). + * \param sol pointer to a solution structure. + * \param met pointer to the solution (metric) structure. * * Pack the sparse mesh and create edges before getting * out of library diff --git a/src/mmgs/libmmgs.h b/src/mmgs/libmmgs.h index 1be61eeb7..4f2a9a67c 100644 --- a/src/mmgs/libmmgs.h +++ b/src/mmgs/libmmgs.h @@ -123,8 +123,8 @@ enum MMGS_Param { LIBMMGS_EXPORT int MMGS_Init_mesh(const int starter,...); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure. * * Initialize file names to their default values. * @@ -136,7 +136,7 @@ LIBMMGS_EXPORT int MMGS_Init_mesh(const int starter,...); */ LIBMMGS_EXPORT void MMGS_Init_fileNames(MMG5_pMesh mesh, MMG5_pSol sol); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * * Initialization of the input parameters (stored in the Info structure). * @@ -150,7 +150,7 @@ LIBMMGS_EXPORT void MMGS_Init_parameters(MMG5_pMesh mesh); /* init file names */ /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param meshin input mesh name. * \return 1. * @@ -167,7 +167,7 @@ LIBMMGS_EXPORT void MMGS_Init_parameters(MMG5_pMesh mesh); */ LIBMMGS_EXPORT int MMGS_Set_inputMeshName(MMG5_pMesh mesh, const char* meshin); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param meshout name of the output mesh file. * \return 1. * @@ -184,8 +184,8 @@ LIBMMGS_EXPORT int MMGS_Set_inputMeshName(MMG5_pMesh mesh, const char* meshin); */ LIBMMGS_EXPORT int MMGS_Set_outputMeshName(MMG5_pMesh mesh, const char* meshout); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure. * \param solin name of the input solution file. * \return 1. * @@ -202,8 +202,8 @@ LIBMMGS_EXPORT int MMGS_Set_outputMeshName(MMG5_pMesh mesh, const char* meshout */ LIBMMGS_EXPORT int MMGS_Set_inputSolName(MMG5_pMesh mesh,MMG5_pSol sol, const char* solin); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure. * \param solout name of the output solution file. * \return 0 if failed, 1 otherwise. * @@ -220,7 +220,7 @@ LIBMMGS_EXPORT int MMGS_Set_inputSolName(MMG5_pMesh mesh,MMG5_pSol sol, const c */ LIBMMGS_EXPORT int MMGS_Set_outputSolName(MMG5_pMesh mesh,MMG5_pSol sol, const char* solout); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param fparamin name of the input parameter file. * \return 1. * @@ -239,8 +239,8 @@ LIBMMGS_EXPORT int MMGS_Set_inputParamName(MMG5_pMesh mesh, const char* fparami /* init structure sizes */ /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure. * \param typEntity type of solutions entities (vertices, triangles...). * \param np number of solutions. * \param typSol type of solution (scalar, vectorial...). @@ -261,8 +261,8 @@ LIBMMGS_EXPORT int MMGS_Set_inputParamName(MMG5_pMesh mesh, const char* fparami */ LIBMMGS_EXPORT int MMGS_Set_solSize(MMG5_pMesh mesh, MMG5_pSol sol, int typEntity, MMG5_int np, int typSol); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward an allocatable sol structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to an allocatable sol structure. * \param nsols number of solutions per entity * \param nentities number of entities * \param typSol Array of size nsol listing the type of the solutions @@ -286,7 +286,7 @@ LIBMMGS_EXPORT int MMGS_Set_inputParamName(MMG5_pMesh mesh, const char* fparami LIBMMGS_EXPORT int MMGS_Set_solsAtVerticesSize(MMG5_pMesh mesh, MMG5_pSol *sol,int nsols, MMG5_int nentities, int *typSol); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param np number of vertices. * \param nt number of triangles. * \param na number of edges. @@ -308,7 +308,7 @@ LIBMMGS_EXPORT int MMGS_Set_meshSize(MMG5_pMesh mesh, MMG5_int np, MMG5_int nt, /* init structure datas */ /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param c0 coordinate of the point along the first dimension. * \param c1 coordinate of the point along the second dimension. * \param c2 coordinate of the point along the third dimension. @@ -331,7 +331,7 @@ LIBMMGS_EXPORT int MMGS_Set_meshSize(MMG5_pMesh mesh, MMG5_int np, MMG5_int nt, LIBMMGS_EXPORT int MMGS_Set_vertex(MMG5_pMesh mesh, double c0, double c1, double c2, MMG5_int ref,MMG5_int pos); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param vertices table of the points coor. * The coordinates of the \f$i^{th}\f$ point are stored in * vertices[(i-1)*3]\@3. @@ -353,7 +353,7 @@ LIBMMGS_EXPORT int MMGS_Set_vertex(MMG5_pMesh mesh, double c0, double c1, */ LIBMMGS_EXPORT int MMGS_Set_vertices(MMG5_pMesh mesh, double *vertices,MMG5_int *refs); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param v0 first vertex of triangle. * \param v1 second vertex of triangle. * \param v2 third vertex of triangle. @@ -375,10 +375,10 @@ LIBMMGS_EXPORT int MMGS_Set_vertex(MMG5_pMesh mesh, double c0, double c1, LIBMMGS_EXPORT int MMGS_Set_triangle(MMG5_pMesh mesh, MMG5_int v0, MMG5_int v1, MMG5_int v2, MMG5_int ref,MMG5_int pos); /** - * \param mesh pointer toward the mesh structure. - * \param tria pointer toward the table of the tria vertices + * \param mesh pointer to the mesh structure. + * \param tria pointer to the table of the tria vertices * Vertices of the \f$i^{th}\f$ tria are stored in tria[(i-1)*3]\@3. - * \param refs pointer toward the table of the triangle references. + * \param refs pointer to the table of the triangle references. * refs[i-1] is the ref of the \f$i^{th}\f$ tria. * \return 0 if failed, 1 otherwise. * @@ -395,7 +395,7 @@ LIBMMGS_EXPORT int MMGS_Set_triangle(MMG5_pMesh mesh, MMG5_int v0, MMG5_int v1, */ LIBMMGS_EXPORT int MMGS_Set_triangles(MMG5_pMesh mesh, MMG5_int *tria, MMG5_int *refs); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param v0 first extremity of the edge. * \param v1 second extremity of the edge. * \param ref edge reference. @@ -415,7 +415,7 @@ LIBMMGS_EXPORT int MMGS_Set_triangle(MMG5_pMesh mesh, MMG5_int v0, MMG5_int v1, */ LIBMMGS_EXPORT int MMGS_Set_edge(MMG5_pMesh mesh, MMG5_int v0, MMG5_int v1, MMG5_int ref,MMG5_int pos); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param k vertex index. * \return 1. * @@ -431,7 +431,7 @@ LIBMMGS_EXPORT int MMGS_Set_edge(MMG5_pMesh mesh, MMG5_int v0, MMG5_int v1, MMG */ LIBMMGS_EXPORT int MMGS_Set_corner(MMG5_pMesh mesh, MMG5_int k); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param k vertex index. * \return 1. * @@ -448,7 +448,7 @@ LIBMMGS_EXPORT int MMGS_Set_corner(MMG5_pMesh mesh, MMG5_int k); */ LIBMMGS_EXPORT int MMGS_Unset_corner(MMG5_pMesh mesh, MMG5_int k); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param k vertex index. * \return 1. * @@ -464,7 +464,7 @@ LIBMMGS_EXPORT int MMGS_Unset_corner(MMG5_pMesh mesh, MMG5_int k); */ LIBMMGS_EXPORT int MMGS_Set_requiredVertex(MMG5_pMesh mesh, MMG5_int k); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param k vertex index. * \return 1. * @@ -481,7 +481,7 @@ LIBMMGS_EXPORT int MMGS_Unset_corner(MMG5_pMesh mesh, MMG5_int k); LIBMMGS_EXPORT int MMGS_Unset_requiredVertex(MMG5_pMesh mesh, MMG5_int k); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param k triangle index. * \return 1. * @@ -498,7 +498,7 @@ LIBMMGS_EXPORT int MMGS_Unset_corner(MMG5_pMesh mesh, MMG5_int k); LIBMMGS_EXPORT int MMGS_Set_requiredTriangle(MMG5_pMesh mesh, MMG5_int k); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param k triangle index. * \return 1. * @@ -515,7 +515,7 @@ LIBMMGS_EXPORT int MMGS_Set_requiredTriangle(MMG5_pMesh mesh, MMG5_int k); LIBMMGS_EXPORT int MMGS_Unset_requiredTriangle(MMG5_pMesh mesh, MMG5_int k); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param k edge index. * \return 1. * @@ -532,7 +532,7 @@ LIBMMGS_EXPORT int MMGS_Set_requiredTriangle(MMG5_pMesh mesh, MMG5_int k); LIBMMGS_EXPORT int MMGS_Set_ridge(MMG5_pMesh mesh, MMG5_int k); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param k edge index. * \return 1. * @@ -549,7 +549,7 @@ LIBMMGS_EXPORT int MMGS_Set_ridge(MMG5_pMesh mesh, MMG5_int k); LIBMMGS_EXPORT int MMGS_Unset_ridge(MMG5_pMesh mesh, MMG5_int k); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param k edge index. * \return 1. * @@ -566,7 +566,7 @@ LIBMMGS_EXPORT int MMGS_Unset_ridge(MMG5_pMesh mesh, MMG5_int k); LIBMMGS_EXPORT int MMGS_Set_requiredEdge(MMG5_pMesh mesh, MMG5_int k); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param k edge index. * \return 1. * @@ -583,8 +583,8 @@ LIBMMGS_EXPORT int MMGS_Set_requiredEdge(MMG5_pMesh mesh, MMG5_int k); LIBMMGS_EXPORT int MMGS_Unset_requiredEdge(MMG5_pMesh mesh, MMG5_int k); /** - * \param mesh pointer toward the mesh structure. - * \param edges pointer toward the array of edges. + * \param mesh pointer to the mesh structure. + * \param edges pointer to the array of edges. * Vertices of the \f$i^{th}\f$ edge are stored in edge[(i-1)*2]\@2. * \param refs edges references. refs[i-1] is the ref of the \f$i^{th}\f$ edge. * \return 0 if failed, 1 otherwise. @@ -601,8 +601,8 @@ LIBMMGS_EXPORT int MMGS_Set_requiredEdge(MMG5_pMesh mesh, MMG5_int k); */ LIBMMGS_EXPORT int MMGS_Set_edges(MMG5_pMesh mesh, MMG5_int *edges, MMG5_int* refs); /** - * \param mesh pointer toward the mesh structure. - * \param edges pointer toward the array of edges. + * \param mesh pointer to the mesh structure. + * \param edges pointer to the array of edges. * Vertices of the \f$i^{th}\f$ edge are stored in edge[(i-1)*2]\@2. * \param refs edges references. refs[i-1] is the ref of the \f$i^{th}\f$ edge. * \param areRidges 1 if the edge is a ridge, 0 otherwise. @@ -624,7 +624,7 @@ LIBMMGS_EXPORT int MMGS_Set_requiredEdge(MMG5_pMesh mesh, MMG5_int k); int *areRidges,int *areRequired); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param k point index * \param n0 x componant of the normal at point \a k. * \param n1 y componant of the normal at point \a k. @@ -646,8 +646,8 @@ LIBMMGS_EXPORT int MMGS_Set_requiredEdge(MMG5_pMesh mesh, MMG5_int k); LIBMMGS_EXPORT int MMGS_Set_normalAtVertex(MMG5_pMesh mesh, MMG5_int k, double n0, double n1, double n2) ; /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k index of the triangle for which we want to get the quality. * \return the computed quality or 0. if fail. * @@ -664,7 +664,7 @@ LIBMMGS_EXPORT int MMGS_Set_normalAtVertex(MMG5_pMesh mesh, MMG5_int k, double double MMGS_Get_triangleQuality(MMG5_pMesh mesh,MMG5_pSol met, MMG5_int k); /** - * \param met pointer toward the sol structure. + * \param met pointer to the sol structure. * \param s solution scalar value. * \param pos position of the solution in the mesh. * \return 0 if failed, 1 otherwise. @@ -683,7 +683,7 @@ LIBMMGS_EXPORT int MMGS_Set_normalAtVertex(MMG5_pMesh mesh, MMG5_int k, double */ LIBMMGS_EXPORT int MMGS_Set_scalarSol(MMG5_pSol met, double s,MMG5_int pos); /** - * \param met pointer toward the sol structure. + * \param met pointer to the sol structure. * \param s table of the scalar solutions values. * s[i-1] is the solution at vertex i. * \return 0 if failed, 1 otherwise. @@ -700,7 +700,7 @@ LIBMMGS_EXPORT int MMGS_Set_scalarSol(MMG5_pSol met, double s,MMG5_int pos); */ LIBMMGS_EXPORT int MMGS_Set_scalarSols(MMG5_pSol met, double *s); /** - * \param met pointer toward the sol structure. + * \param met pointer to the sol structure. * \param vx x value of the vectorial solution. * \param vy y value of the vectorial solution. * \param vz z value of the vectorial solution. @@ -722,7 +722,7 @@ LIBMMGS_EXPORT int MMGS_Set_scalarSols(MMG5_pSol met, double *s); */ LIBMMGS_EXPORT int MMGS_Set_vectorSol(MMG5_pSol met, double vx,double vy, double vz, MMG5_int pos); /** - * \param met pointer toward the sol structure. + * \param met pointer to the sol structure. * \param sols table of the vectorial solutions * sols[3*(i-1)]\@3 is the solution at vertex i * \return 0 if failed, 1 otherwise. @@ -739,7 +739,7 @@ LIBMMGS_EXPORT int MMGS_Set_vectorSol(MMG5_pSol met, double vx,double vy, double */ LIBMMGS_EXPORT int MMGS_Set_vectorSols(MMG5_pSol met, double *sols); /** - * \param met pointer toward the sol structure. + * \param met pointer to the sol structure. * \param m11 value of the tensorial solution at position (1,1) in the tensor. * \param m12 value of the tensorial solution at position (1,2) in the tensor. * \param m13 value of the tensorial solution at position (1,3) in the tensor. @@ -765,7 +765,7 @@ LIBMMGS_EXPORT int MMGS_Set_vectorSols(MMG5_pSol met, double *sols); LIBMMGS_EXPORT int MMGS_Set_tensorSol(MMG5_pSol met, double m11,double m12, double m13, double m22,double m23, double m33, MMG5_int pos); /** - * \param met pointer toward the sol structure. + * \param met pointer to the sol structure. * \param sols table of the tensorial solutions. * sols[6*(i-1)]\@6 is the solution at vertex i * \return 0 if failed, 1 otherwise. @@ -782,7 +782,7 @@ LIBMMGS_EXPORT int MMGS_Set_tensorSol(MMG5_pSol met, double m11,double m12, doub */ LIBMMGS_EXPORT int MMGS_Set_tensorSols(MMG5_pSol met, double *sols); /** - * \param sol pointer toward the array of solutions + * \param sol pointer to the array of solutions * \param i position of the solution field that we want to set. * \param s solution(s) at mesh vertex \a pos. * \param pos index of the vertex on which we set the solution. @@ -804,7 +804,7 @@ LIBMMGS_EXPORT int MMGS_Set_tensorSols(MMG5_pSol met, double *sols); */ LIBMMGS_EXPORT int MMGS_Set_ithSol_inSolsAtVertices(MMG5_pSol sol,int i, double* s,MMG5_int pos); /** - * \param sol pointer toward the array of solutions + * \param sol pointer to the array of solutions * \param i position of the solution field that we want to set. * \param s table of the solutions at mesh vertices. The solution at vertex \a k * is given by s[k-1] for a scalar sol, s[3*(k-1)]\@3 for a vectorial solution @@ -828,8 +828,8 @@ LIBMMGS_EXPORT int MMGS_Set_tensorSols(MMG5_pSol met, double *sols); /* check init */ /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the sol structure. * \return 0 if failed, 1 otherwise. * * Check if the number of given entities match with mesh and sol size @@ -846,8 +846,8 @@ LIBMMGS_EXPORT int MMGS_Chk_meshData(MMG5_pMesh mesh, MMG5_pSol met); /** functions to set parameters */ /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure (unused). + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure (unused). * \param iparam integer parameter to set (see \a MMGS_Param structure). * \param val value for the parameter. * \return 0 if failed, 1 otherwise. @@ -866,8 +866,8 @@ LIBMMGS_EXPORT int MMGS_Chk_meshData(MMG5_pMesh mesh, MMG5_pSol met); */ LIBMMGS_EXPORT int MMGS_Set_iparameter(MMG5_pMesh mesh,MMG5_pSol sol, int iparam, MMG5_int val); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure (unused). + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure (unused). * \param dparam double parameter to set (see \a MMGS_Param structure). * \param val value of the parameter. * \return 0 if failed, 1 otherwise. @@ -886,8 +886,8 @@ LIBMMGS_EXPORT int MMGS_Set_iparameter(MMG5_pMesh mesh,MMG5_pSol sol, int ipara */ LIBMMGS_EXPORT int MMGS_Set_dparameter(MMG5_pMesh mesh,MMG5_pSol sol, int dparam, double val); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure. * \param typ type of entity (triangle, edge,...). * \param ref reference of the entity. * \param hmin minimal edge size. @@ -913,8 +913,8 @@ LIBMMGS_EXPORT int MMGS_Set_localParameter(MMG5_pMesh mesh, MMG5_pSol sol, int double hmin, double hmax, double hausd); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure. * \param ref input tetra reference. * \param split MMG5_MMAT_NoSplit if the entity must not be splitted, MMG5_MMAT_Split otherwise * \param rin internal reference after ls discretization @@ -936,8 +936,8 @@ LIBMMGS_EXPORT int MMGS_Set_localParameter(MMG5_pMesh mesh, MMG5_pSol sol, int int split,MMG5_int rin, MMG5_int rex); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure. * \param br new level-set base reference. * \return 0 if failed, 1 otherwise. * @@ -958,10 +958,10 @@ LIBMMGS_EXPORT int MMGS_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MMG5 /** recover datas */ /** - * \param mesh pointer toward the mesh structure. - * \param np pointer toward the number of vertices. - * \param nt pointer toward the number of triangles. - * \param na pointer toward the number of edges. + * \param mesh pointer to the mesh structure. + * \param np pointer to the number of vertices. + * \param nt pointer to the number of triangles. + * \param na pointer to the number of edges. * \return 1. * * Get the number of vertices, triangles and edges of the mesh. @@ -976,11 +976,11 @@ LIBMMGS_EXPORT int MMGS_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MMG5 */ LIBMMGS_EXPORT int MMGS_Get_meshSize(MMG5_pMesh mesh, MMG5_int* np, MMG5_int* nt, MMG5_int* na); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol structure. - * \param typEntity pointer toward the type of entities to which solutions are applied. - * \param np pointer toward the number of solutions. - * \param typSol pointer toward the type of the solutions (scalar, vectorial...) + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol structure. + * \param typEntity pointer to the type of entities to which solutions are applied. + * \param np pointer to the number of solutions. + * \param typSol pointer to the type of the solutions (scalar, vectorial...) * \return 1. * * Get the solution number, dimension and type. @@ -997,10 +997,10 @@ LIBMMGS_EXPORT int MMGS_Get_meshSize(MMG5_pMesh mesh, MMG5_int* np, MMG5_int* n LIBMMGS_EXPORT int MMGS_Get_solSize(MMG5_pMesh mesh, MMG5_pSol sol, int* typEntity, MMG5_int* np, int* typSol); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward an array of sol structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to an array of sol structure. * \param nsols number of solutions per entity - * \param nentities pointer toward the number of entities. + * \param nentities pointer to the number of entities. * \param typSol array of size MMG5_NSOL_MAX to store type of each solution * (scalar, vector..). * @@ -1022,13 +1022,13 @@ LIBMMGS_EXPORT int MMGS_Get_solSize(MMG5_pMesh mesh, MMG5_pSol sol, int* typEnt MMG5_int* nentities,int* typSol); /** - * \param mesh pointer toward the mesh structure. - * \param c0 pointer toward the coordinate of the point along the first dimension. - * \param c1 pointer toward the coordinate of the point along the second dimension. - * \param c2 pointer toward the coordinate of the point along the third dimension. + * \param mesh pointer to the mesh structure. + * \param c0 pointer to the coordinate of the point along the first dimension. + * \param c1 pointer to the coordinate of the point along the second dimension. + * \param c2 pointer to the coordinate of the point along the third dimension. * \param ref pointer to the point reference. - * \param isCorner pointer toward the flag saying if point is corner. - * \param isRequired pointer toward the flag saying if point is required. + * \param isCorner pointer to the flag saying if point is corner. + * \param isRequired pointer to the flag saying if point is required. * \return 1. * * Get coordinates \a c0, \a c1,\a c2 and reference \a ref of next @@ -1047,13 +1047,13 @@ LIBMMGS_EXPORT int MMGS_Get_solSize(MMG5_pMesh mesh, MMG5_pSol sol, int* typEnt LIBMMGS_EXPORT int MMGS_Get_vertex(MMG5_pMesh mesh, double* c0, double* c1, double* c2, MMG5_int* ref, int* isCorner, int* isRequired); /** - * \param mesh pointer toward the mesh structure. - * \param c0 pointer toward the coordinate of the point along the first dimension. - * \param c1 pointer toward the coordinate of the point along the second dimension. - * \param c2 pointer toward the coordinate of the point along the third dimension. + * \param mesh pointer to the mesh structure. + * \param c0 pointer to the coordinate of the point along the first dimension. + * \param c1 pointer to the coordinate of the point along the second dimension. + * \param c2 pointer to the coordinate of the point along the third dimension. * \param ref pointer to the point reference. - * \param isCorner pointer toward the flag saying if point is corner. - * \param isRequired pointer toward the flag saying if point is required. + * \param isCorner pointer to the flag saying if point is corner. + * \param isRequired pointer to the flag saying if point is required. * \param idx index of point to get. * \return 1. * @@ -1074,16 +1074,16 @@ LIBMMGS_EXPORT int MMGS_Get_vertex(MMG5_pMesh mesh, double* c0, double* c1, dou int* isCorner, int* isRequired,MMG5_int idx); /** - * \param mesh pointer toward the mesh structure. - * \param vertices pointer toward the table of the points coordinates. + * \param mesh pointer to the mesh structure. + * \param vertices pointer to the table of the points coordinates. * The coordinates of the \f$i^{th}\f$ point are stored in * vertices[(i-1)*3]\@3. * \param refs pointer to the table of the point references. * The ref of the \f$i^th\f$ point is stored in refs[i-1]. - * \param areCorners pointer toward the table of the flags saying if + * \param areCorners pointer to the table of the flags saying if * points are corners. * areCorners[i-1]=1 if the \f$i^{th}\f$ point is corner. - * \param areRequired pointer toward the table of flags saying if points + * \param areRequired pointer to the table of flags saying if points * are required. areRequired[i-1]=1 if the \f$i^{th}\f$ point is required. * \return 1. * @@ -1104,12 +1104,12 @@ LIBMMGS_EXPORT int MMGS_Get_vertex(MMG5_pMesh mesh, double* c0, double* c1, dou LIBMMGS_EXPORT int MMGS_Get_vertices(MMG5_pMesh mesh, double* vertices, MMG5_int* refs, int* areCorners, int* areRequired); /** - * \param mesh pointer toward the mesh structure. - * \param v0 pointer toward the first vertex of triangle. - * \param v1 pointer toward the second vertex of triangle. - * \param v2 pointer toward the third vertex of triangle. - * \param ref pointer toward the triangle reference. - * \param isRequired pointer toward the flag saying if triangle is required. + * \param mesh pointer to the mesh structure. + * \param v0 pointer to the first vertex of triangle. + * \param v1 pointer to the second vertex of triangle. + * \param v2 pointer to the third vertex of triangle. + * \param ref pointer to the triangle reference. + * \param isRequired pointer to the flag saying if triangle is required. * \return 0 if failed, 1 otherwise. * * Get vertices \a v0,\a v1,\a v2 and reference \a ref of next @@ -1127,12 +1127,12 @@ LIBMMGS_EXPORT int MMGS_Get_vertices(MMG5_pMesh mesh, double* vertices, MMG5_in LIBMMGS_EXPORT int MMGS_Get_triangle(MMG5_pMesh mesh, MMG5_int* v0, MMG5_int* v1, MMG5_int* v2, MMG5_int* ref, int* isRequired); /** - * \param mesh pointer toward the mesh structure. - * \param tria pointer toward the table of the triangles vertices + * \param mesh pointer to the mesh structure. + * \param tria pointer to the table of the triangles vertices * Vertices of the \f$i^{th}\f$ tria are stored in tria[(i-1)*3]\@3. - * \param refs pointer toward the table of the triangles references. + * \param refs pointer to the table of the triangles references. * refs[i-1] is the ref of the \f$i^{th}\f$ tria. - * \param areRequired pointer toward table of the flags saying if triangles + * \param areRequired pointer to table of the flags saying if triangles * are required. areRequired[i-1]=1 if the \f$i^{th}\f$ tria * is required. * \return 0 if failed, 1 otherwise. @@ -1153,12 +1153,12 @@ LIBMMGS_EXPORT int MMGS_Get_triangle(MMG5_pMesh mesh, MMG5_int* v0, MMG5_int* v LIBMMGS_EXPORT int MMGS_Get_triangles(MMG5_pMesh mesh, MMG5_int* tria, MMG5_int* refs, int* areRequired); /** - * \param mesh pointer toward the mesh structure. - * \param e0 pointer toward the first extremity of the edge. - * \param e1 pointer toward the second extremity of the edge. - * \param ref pointer toward the edge reference. - * \param isRidge pointer toward the flag saying if the edge is ridge. - * \param isRequired pointer toward the flag saying if the edge is required. + * \param mesh pointer to the mesh structure. + * \param e0 pointer to the first extremity of the edge. + * \param e1 pointer to the second extremity of the edge. + * \param ref pointer to the edge reference. + * \param isRidge pointer to the flag saying if the edge is ridge. + * \param isRequired pointer to the flag saying if the edge is required. * \return 0 if failed, 1 otherwise. * * Get extremities \a e0, \a e1 and reference \a ref of next edge of mesh. @@ -1177,7 +1177,7 @@ LIBMMGS_EXPORT int MMGS_Get_edge(MMG5_pMesh mesh, MMG5_int* e0, MMG5_int* e1, M int* isRidge, int* isRequired); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param k point index * \param n0 x componant of the normal at point \a k. * \param n1 y componant of the normal at point \a k. @@ -1199,8 +1199,8 @@ LIBMMGS_EXPORT int MMGS_Get_edge(MMG5_pMesh mesh, MMG5_int* e0, MMG5_int* e1, M LIBMMGS_EXPORT int MMGS_Get_normalAtVertex(MMG5_pMesh mesh, MMG5_int k, double *n0, double *n1, double *n2) ; /** - * \param met pointer toward the sol structure. - * \param s pointer toward the scalar solution value. + * \param met pointer to the sol structure. + * \param s pointer to the scalar solution value. * \return 0 if failed, 1 otherwise. * * Get solution \a s of next vertex of mesh. @@ -1215,7 +1215,7 @@ LIBMMGS_EXPORT int MMGS_Get_normalAtVertex(MMG5_pMesh mesh, MMG5_int k, double */ LIBMMGS_EXPORT int MMGS_Get_scalarSol(MMG5_pSol met, double* s); /** - * \param met pointer toward the sol structure. + * \param met pointer to the sol structure. * \param s table of the scalar solutions at mesh vertices. s[i-1] is * the solution at vertex i. * \return 0 if failed, 1 otherwise. @@ -1232,7 +1232,7 @@ LIBMMGS_EXPORT int MMGS_Get_scalarSol(MMG5_pSol met, double* s); */ LIBMMGS_EXPORT int MMGS_Get_scalarSols(MMG5_pSol met, double* s); /** - * \param met pointer toward the sol structure. + * \param met pointer to the sol structure. * \param vx x value of the vectorial solution. * \param vy y value of the vectorial solution. * \param vz z value of the vectorial solution. @@ -1250,7 +1250,7 @@ LIBMMGS_EXPORT int MMGS_Get_scalarSols(MMG5_pSol met, double* s); */ LIBMMGS_EXPORT int MMGS_Get_vectorSol(MMG5_pSol met, double* vx, double* vy, double* vz); /** - * \param met pointer toward the sol structure. + * \param met pointer to the sol structure. * \param sols table of the solutions at mesh vertices. sols[3*(i-1)]\@3 is * the solution at vertex i. * \return 0 if failed, 1 otherwise. @@ -1267,13 +1267,13 @@ LIBMMGS_EXPORT int MMGS_Get_vectorSol(MMG5_pSol met, double* vx, double* vy, dou */ LIBMMGS_EXPORT int MMGS_Get_vectorSols(MMG5_pSol met, double* sols); /** - * \param met pointer toward the sol structure. - * \param m11 pointer toward the position (1,1) in the solution tensor. - * \param m12 pointer toward the position (1,2) in the solution tensor. - * \param m13 pointer toward the position (1,3) in the solution tensor. - * \param m22 pointer toward the position (2,2) in the solution tensor. - * \param m23 pointer toward the position (2,3) in the solution tensor. - * \param m33 pointer toward the position (3,3) in the solution tensor. + * \param met pointer to the sol structure. + * \param m11 pointer to the position (1,1) in the solution tensor. + * \param m12 pointer to the position (1,2) in the solution tensor. + * \param m13 pointer to the position (1,3) in the solution tensor. + * \param m22 pointer to the position (2,2) in the solution tensor. + * \param m23 pointer to the position (2,3) in the solution tensor. + * \param m33 pointer to the position (3,3) in the solution tensor. * \return 0 if failed, 1 otherwise. * * Get tensorial solution of next vertex of mesh. @@ -1289,7 +1289,7 @@ LIBMMGS_EXPORT int MMGS_Get_vectorSols(MMG5_pSol met, double* sols); LIBMMGS_EXPORT int MMGS_Get_tensorSol(MMG5_pSol met, double *m11,double *m12, double *m13, double *m22,double *m23, double *m33); /** - * \param met pointer toward the sol structure. + * \param met pointer to the sol structure. * \param sols table of the solutions at mesh vertices. * sols[6*(i-1)]\@6 is the solution at vertex i. * \return 0 if failed, 1 otherwise. @@ -1306,7 +1306,7 @@ LIBMMGS_EXPORT int MMGS_Get_tensorSol(MMG5_pSol met, double *m11,double *m12, do */ LIBMMGS_EXPORT int MMGS_Get_tensorSols(MMG5_pSol met, double *sols); /** - * \param sol pointer toward the array of solutions + * \param sol pointer to the array of solutions * \param i position of the solution field that we want to set. * \param s solution(s) at mesh vertex \a pos. * \param pos index of the vertex on which we get the solution. @@ -1328,7 +1328,7 @@ LIBMMGS_EXPORT int MMGS_Get_tensorSols(MMG5_pSol met, double *sols); */ LIBMMGS_EXPORT int MMGS_Get_ithSol_inSolsAtVertices(MMG5_pSol sol,int i, double* s,MMG5_int pos); /** - * \param sol pointer toward the array of solutions + * \param sol pointer to the array of solutions * \param i position of the solution field that we want to get. * \param s table of the solutions at mesh vertices. The solution at vertex \a k * is given by s[k-1] for a scalar sol, s[3*(k-1)]\@3 for a vectorial solution @@ -1350,7 +1350,7 @@ LIBMMGS_EXPORT int MMGS_Get_tensorSols(MMG5_pSol met, double *sols); */ LIBMMGS_EXPORT int MMGS_Get_ithSols_inSolsAtVertices(MMG5_pSol sol,int i, double* s); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param iparam integer parameter to set (see \a MMGS_Param structure). * \return The value of integer parameter. * @@ -1368,7 +1368,7 @@ LIBMMGS_EXPORT int MMGS_Get_iparameter(MMG5_pMesh mesh, MMG5_int iparam); /* input/output functions */ /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param filename name of file. * \return 0 if failed, 1 otherwise. * @@ -1386,9 +1386,9 @@ LIBMMGS_EXPORT int MMGS_Get_iparameter(MMG5_pMesh mesh, MMG5_int iparam); LIBMMGS_EXPORT int MMGS_loadMesh(MMG5_pMesh mesh, const char* filename); /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure or the NULL pointer. - * \param sol pointer toward the level-set structure or the NULL pointer. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure or the NULL pointer. + * \param sol pointer to the level-set structure or the NULL pointer. * \param filename name of file. * \return 0 if failed, 1 otherwise. * @@ -1406,8 +1406,8 @@ LIBMMGS_EXPORT int MMGS_loadMesh(MMG5_pMesh mesh, const char* filename); */ LIBMMGS_EXPORT int MMGS_loadVtpMesh(MMG5_pMesh mesh,MMG5_pSol met,MMG5_pSol sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solution structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solution structure. * \param filename name of file. * \return 0 if failed, 1 otherwise. * @@ -1425,9 +1425,9 @@ LIBMMGS_EXPORT int MMGS_loadVtpMesh(MMG5_pMesh mesh,MMG5_pSol met,MMG5_pSol sol, */ LIBMMGS_EXPORT int MMGS_loadVtpMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure or the NULL pointer. - * \param sol pointer toward the level-set structure or the NULL pointer. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure or the NULL pointer. + * \param sol pointer to the level-set structure or the NULL pointer. * \param filename name of file. * \return 0 if failed, 1 otherwise. * @@ -1446,8 +1446,8 @@ LIBMMGS_EXPORT int MMGS_loadVtpMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol,c LIBMMGS_EXPORT int MMGS_loadVtuMesh(MMG5_pMesh mesh,MMG5_pSol met,MMG5_pSol sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solution structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solution structure. * \param filename name of file. * \return 0 if failed, 1 otherwise. * @@ -1466,9 +1466,9 @@ LIBMMGS_EXPORT int MMGS_loadVtuMesh(MMG5_pMesh mesh,MMG5_pSol met,MMG5_pSol sol, LIBMMGS_EXPORT int MMGS_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure or the NULL pointer. - * \param sol pointer toward the level-set structure or the NULL pointer. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure or the NULL pointer. + * \param sol pointer to the level-set structure or the NULL pointer. * \param filename name of file. * \return 0 if failed, 1 otherwise. * @@ -1487,8 +1487,8 @@ LIBMMGS_EXPORT int MMGS_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol,c LIBMMGS_EXPORT int MMGS_loadVtkMesh(MMG5_pMesh mesh,MMG5_pSol met,MMG5_pSol sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solution structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solution structure. * \param filename name of file. * \return 0 if failed, 1 otherwise. * @@ -1507,8 +1507,8 @@ LIBMMGS_EXPORT int MMGS_loadVtkMesh(MMG5_pMesh mesh,MMG5_pSol met,MMG5_pSol sol, LIBMMGS_EXPORT int MMGS_loadVtkMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solution structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solution structure. * \param filename name of file. * \return 0 if failed, 1 otherwise. * @@ -1527,8 +1527,8 @@ LIBMMGS_EXPORT int MMGS_loadVtkMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol,c LIBMMGS_EXPORT int MMGS_loadMshMesh(MMG5_pMesh mesh,MMG5_pSol sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward a list of solution structures. + * \param mesh pointer to the mesh structure. + * \param sol pointer to a list of solution structures. * \param filename name of file. * \return 0 if failed, 1 otherwise. * @@ -1547,9 +1547,9 @@ LIBMMGS_EXPORT int MMGS_loadMshMesh(MMG5_pMesh mesh,MMG5_pSol sol,const char *fi LIBMMGS_EXPORT int MMGS_loadMshMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure or the NULL pointer. - * \param sol pointer toward the level-set structure or the NULL pointer. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure or the NULL pointer. + * \param sol pointer to the level-set structure or the NULL pointer. * \param filename name of file. * \return 0 if failed, 1 otherwise. * @@ -1567,7 +1567,7 @@ LIBMMGS_EXPORT int MMGS_loadMshMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol,c LIBMMGS_EXPORT int MMGS_loadGenericMesh(MMG5_pMesh mesh,MMG5_pSol met,MMG5_pSol sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param filename name of file. * \return 0 if failed, 1 otherwise. * @@ -1585,8 +1585,8 @@ LIBMMGS_EXPORT int MMGS_loadGenericMesh(MMG5_pMesh mesh,MMG5_pSol met,MMG5_pSol LIBMMGS_EXPORT int MMGS_saveMesh(MMG5_pMesh mesh, const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solution structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solution structure. * \param filename name of file. * \return 0 if failed, 1 otherwise. * @@ -1605,8 +1605,8 @@ LIBMMGS_EXPORT int MMGS_saveMesh(MMG5_pMesh mesh, const char *filename); LIBMMGS_EXPORT int MMGS_saveMshMesh(MMG5_pMesh mesh,MMG5_pSol sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solution structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solution structure. * \param filename name of file. * \return 0 if failed, 1 otherwise. * @@ -1627,8 +1627,8 @@ LIBMMGS_EXPORT int MMGS_saveMshMesh(MMG5_pMesh mesh,MMG5_pSol sol,const char *fi LIBMMGS_EXPORT int MMGS_saveMshMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solution structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solution structure. * \param filename name of file. * \return 0 if failed, 1 otherwise. * @@ -1645,8 +1645,8 @@ LIBMMGS_EXPORT int MMGS_saveMshMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol,c */ LIBMMGS_EXPORT int MMGS_saveVtkMesh(MMG5_pMesh mesh,MMG5_pSol sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solution structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solution structure. * \param filename name of file. * \return 0 if failed, 1 otherwise. * @@ -1663,8 +1663,8 @@ LIBMMGS_EXPORT int MMGS_saveVtkMesh(MMG5_pMesh mesh,MMG5_pSol sol,const char *fi */ LIBMMGS_EXPORT int MMGS_saveVtkMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solution structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solution structure. * \param filename name of file. * \return 0 if failed, 1 otherwise. * @@ -1681,8 +1681,8 @@ LIBMMGS_EXPORT int MMGS_saveVtkMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol,c */ LIBMMGS_EXPORT int MMGS_saveVtuMesh(MMG5_pMesh mesh,MMG5_pSol sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solution structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solution structure. * \param filename name of file. * \return 0 if failed, 1 otherwise. * @@ -1699,8 +1699,8 @@ LIBMMGS_EXPORT int MMGS_saveVtuMesh(MMG5_pMesh mesh,MMG5_pSol sol,const char *fi */ LIBMMGS_EXPORT int MMGS_saveVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solution structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solution structure. * \param filename name of file. * \return 0 if failed, 1 otherwise. * @@ -1717,8 +1717,8 @@ LIBMMGS_EXPORT int MMGS_saveVtuMesh(MMG5_pMesh mesh,MMG5_pSol sol,const char *fi */ LIBMMGS_EXPORT int MMGS_saveVtpMesh(MMG5_pMesh mesh,MMG5_pSol sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solution structure. + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solution structure. * \param filename name of file. * \return 0 if failed, 1 otherwise. * @@ -1736,7 +1736,7 @@ LIBMMGS_EXPORT int MMGS_saveVtuMesh(MMG5_pMesh mesh,MMG5_pSol sol,const char *fi LIBMMGS_EXPORT int MMGS_saveVtpMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param filename name of file. * \return 0 if failed, 1 otherwise. * @@ -1754,8 +1754,8 @@ LIBMMGS_EXPORT int MMGS_saveVtuMesh(MMG5_pMesh mesh,MMG5_pSol sol,const char *fi LIBMMGS_EXPORT int MMGS_saveGenericMesh(MMG5_pMesh mesh,MMG5_pSol sol,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the sol structure. * \param filename name of file. * \return 0 if failed, 1 otherwise. * @@ -1773,8 +1773,8 @@ LIBMMGS_EXPORT int MMGS_saveVtuMesh(MMG5_pMesh mesh,MMG5_pSol sol,const char *fi */ LIBMMGS_EXPORT int MMGS_loadSol(MMG5_pMesh mesh,MMG5_pSol met, const char* filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solutions array + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solutions array * \param filename name of file. * \return 0 if failed, 1 otherwise. * @@ -1791,8 +1791,8 @@ LIBMMGS_EXPORT int MMGS_saveVtuMesh(MMG5_pMesh mesh,MMG5_pSol sol,const char *fi */ LIBMMGS_EXPORT int MMGS_loadAllSols(MMG5_pMesh mesh,MMG5_pSol *sol, const char* filename); /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the sol structure. * \param filename name of file. * \return 0 if failed, 1 otherwise. * @@ -1809,8 +1809,8 @@ LIBMMGS_EXPORT int MMGS_loadAllSols(MMG5_pMesh mesh,MMG5_pSol *sol, const char* */ LIBMMGS_EXPORT int MMGS_saveSol(MMG5_pMesh mesh, MMG5_pSol met, const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solutions array + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solutions array * \param filename name of the solution file. * \return 0 or -1 if fail, 1 otherwise. * @@ -1828,8 +1828,8 @@ LIBMMGS_EXPORT int MMGS_saveSol(MMG5_pMesh mesh, MMG5_pSol met, const char *fil LIBMMGS_EXPORT int MMGS_saveAllSols(MMG5_pMesh mesh,MMG5_pSol *sol ,const char *filename); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward an array of solution structure (that stores solution fields). + * \param mesh pointer to the mesh structure. + * \param sol pointer to an array of solution structure (that stores solution fields). * \return 1 * * Deallocation of an array of solution fields @@ -1890,8 +1890,8 @@ LIBMMGS_EXPORT int MMGS_Free_all(const int starter,...); * Here,\a your_mesh is a \a MMG5_pMesh, \a your_metric and \a your_level_set * are \a MMG5_pSol. * - * Here, \a your_mesh is a pointer toward \a MMG5_pMesh and \a your_metric and - * \a your_level_set a pointer toward \a MMG5_pSol. + * Here, \a your_mesh is a pointer to \a MMG5_pMesh and \a your_metric and + * \a your_level_set a pointer to \a MMG5_pSol. * * \return 0 if fail, 1 if success * @@ -1936,8 +1936,8 @@ LIBMMGS_EXPORT int MMGS_Free_names(const int starter,...); /* library */ /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the sol (metric) structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the sol (metric) structure. * \return \ref MMG5_SUCCESS if success, \ref MMG5_LOWFAILURE if fail but a * conform mesh is saved or \ref MMG5_STRONGFAILURE if fail and we can't save * the mesh. @@ -1954,9 +1954,9 @@ LIBMMGS_EXPORT int MMGS_Free_names(const int starter,...); LIBMMGS_EXPORT int MMGS_mmgslib(MMG5_pMesh mesh, MMG5_pSol met); /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the sol (level-set) structure. - * \param met pointer toward the sol (metric) structure (optionnal). + * \param mesh pointer to the mesh structure. + * \param sol pointer to the sol (level-set) structure. + * \param met pointer to the sol (metric) structure (optionnal). * \return \ref MMG5_SUCCESS if success, \ref MMG5_LOWFAILURE if fail but a * conform mesh is saved or \ref MMG5_STRONGFAILURE if fail and we can't save * the mesh. @@ -1976,8 +1976,8 @@ LIBMMGS_EXPORT int MMGS_mmgsls(MMG5_pMesh mesh, MMG5_pSol sol,MMG5_pSol met); /** To associate function pointers without calling MMGS_mmgslib */ /** - * \param mesh pointer toward the mesh structure (unused). - * \param met pointer toward the sol structure (unused). + * \param mesh pointer to the mesh structure (unused). + * \param met pointer to the sol structure (unused). * * Set function pointers for caltet, lenedg, defsiz and gradsiz. * @@ -1990,8 +1990,8 @@ LIBMMGS_EXPORT int MMGS_mmgsls(MMG5_pMesh mesh, MMG5_pSol sol,MMG5_pSol met); LIBMMGS_EXPORT void MMGS_setfunc(MMG5_pMesh mesh,MMG5_pSol met); /** - * \param mesh pointer toward the mesh structure. - * \param nb_edges pointer toward the number of non boundary edges. + * \param mesh pointer to the mesh structure. + * \param nb_edges pointer to the number of non boundary edges. * \return 0 if failed, 1 otherwise. * * Get the number of non boundary edges (for DG methods for example). An edge is @@ -2014,10 +2014,10 @@ LIBMMGS_EXPORT void MMGS_setfunc(MMG5_pMesh mesh,MMG5_pSol met); LIBMMGS_EXPORT int MMGS_Get_numberOfNonBdyEdges(MMG5_pMesh mesh, MMG5_int* nb_edges); /** - * \param mesh pointer toward the mesh structure. - * \param e0 pointer toward the first extremity of the edge. - * \param e1 pointer toward the second extremity of the edge. - * \param ref pointer toward the edge reference. + * \param mesh pointer to the mesh structure. + * \param e0 pointer to the first extremity of the edge. + * \param e1 pointer to the second extremity of the edge. + * \param ref pointer to the edge reference. * \param idx index of the non boundary edge to get (between 1 and nb_edges) * \return 0 if failed, 1 otherwise. * @@ -2041,8 +2041,8 @@ LIBMMGS_EXPORT void MMGS_setfunc(MMG5_pMesh mesh,MMG5_pSol met); /* Tools for the library */ /** - * \param mesh pointer toward the mesh structure - * \param met pointer toward the sol structure + * \param mesh pointer to the mesh structure + * \param met pointer to the sol structure * \return 1 if success * * Compute isotropic size map according to the mean of the length of the @@ -2058,8 +2058,8 @@ LIBMMGS_EXPORT void MMGS_setfunc(MMG5_pMesh mesh,MMG5_pSol met); LIBMMGS_EXPORT extern int (*MMGS_doSol)(MMG5_pMesh mesh,MMG5_pSol met); /** - * \param mesh pointer toward the mesh structure - * \param met pointer toward the sol structure + * \param mesh pointer to the mesh structure + * \param met pointer to the sol structure * \return 1 if success * * Compute constant size map according to mesh->info.hsiz, mesh->info.hmin and @@ -2075,7 +2075,7 @@ LIBMMGS_EXPORT void MMGS_setfunc(MMG5_pMesh mesh,MMG5_pSol met); LIBMMGS_EXPORT int MMGS_Set_constantSize(MMG5_pMesh mesh,MMG5_pSol met); /** - * \param prog pointer toward the program name. + * \param prog pointer to the program name. * * Print help for mmgs options. * @@ -2091,9 +2091,9 @@ LIBMMGS_EXPORT int MMGS_usage(char *prog); /** * \param argc number of command line arguments. * \param argv command line arguments. - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the sol structure. - * \param sol pointer toward a level-set or displacement + * \param mesh pointer to the mesh structure. + * \param met pointer to the sol structure. + * \param sol pointer to a level-set or displacement * * \return 1. * @@ -2104,7 +2104,7 @@ LIBMMGS_EXPORT int MMGS_usage(char *prog); */ LIBMMGS_EXPORT int MMGS_parsar(int argc,char *argv[],MMG5_pMesh mesh,MMG5_pSol met,MMG5_pSol sol); /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \return 0 if fail, 1 if success. * * Print the default parameters values. @@ -2118,8 +2118,8 @@ LIBMMGS_EXPORT int MMGS_parsar(int argc,char *argv[],MMG5_pMesh mesh,MMG5_pSol */ LIBMMGS_EXPORT int MMGS_defaultValues(MMG5_pMesh mesh); /** - * \param mesh pointer toward the mesh structure. - * \param info pointer toward the info structure. + * \param mesh pointer to the mesh structure. + * \param info pointer to the info structure. * \return 1. * * Store the info structure in the mesh structure. @@ -2133,8 +2133,8 @@ LIBMMGS_EXPORT int MMGS_defaultValues(MMG5_pMesh mesh); */ LIBMMGS_EXPORT int MMGS_stockOptions(MMG5_pMesh mesh, MMG5_Info *info); /** - * \param mesh pointer toward the mesh structure. - * \param info pointer toward the info structure. + * \param mesh pointer to the mesh structure. + * \param info pointer to the info structure. * * Recover the info structure stored in the mesh structure. * @@ -2148,9 +2148,9 @@ LIBMMGS_EXPORT void MMGS_destockOptions(MMG5_pMesh mesh, MMG5_Info *info); /** * \brief Return adjacent elements of a triangle. - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param kel triangle index. - * \param listri pointer toward the table of the indices of the three adjacent + * \param listri pointer to the table of the indices of the three adjacent * triangles of the elt \a kel (the index is 0 if there is no adjacent). * \return 1. * @@ -2171,10 +2171,10 @@ LIBMMGS_EXPORT int MMGS_Get_adjaTri(MMG5_pMesh mesh, MMG5_int kel, MMG5_int list /** * \brief Return adjacent elements of a triangle. - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param ip vertex index. * \param start index of a triangle holding \a ip. - * \param lispoi pointer toward an array of size MMGS_LMAX that will contain + * \param lispoi pointer to an array of size MMGS_LMAX that will contain * the indices of adjacent vertices to the vertex \a ip. * \return nbpoi the number of adjacent points if success, 0 if fail. * @@ -2219,8 +2219,8 @@ LIBMMGS_EXPORT int MMGS_Get_adjaVerticesFast(MMG5_pMesh mesh, MMG5_int ip,MMG5_i LIBMMGS_EXPORT int MMGS_Compute_eigenv(double m[6],double lambda[3],double vp[3][3]); /** - * \param mesh pointer toward the mesh structure - * \param sol pointer toward the solution structure + * \param mesh pointer to the mesh structure + * \param sol pointer to the solution structure * * Free the solution. * @@ -2233,7 +2233,7 @@ LIBMMGS_EXPORT int MMGS_Compute_eigenv(double m[6],double lambda[3],double vp[3] LIBMMGS_EXPORT void MMGS_Free_solutions(MMG5_pMesh mesh,MMG5_pSol sol); /** - * \param mesh pointer toward mesh sructure + * \param mesh pointer to mesh sructure * * \return 1 if successful, 0 otherwise. * diff --git a/src/mmgs/libmmgs_tools.c b/src/mmgs/libmmgs_tools.c index 2640bee28..89f3e884e 100644 --- a/src/mmgs/libmmgs_tools.c +++ b/src/mmgs/libmmgs_tools.c @@ -796,8 +796,8 @@ int MMGS_Get_adjaVerticesFast(MMG5_pMesh mesh, MMG5_int ip,MMG5_int start, MMG5_ } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the solution structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the solution structure. * \param ani 1 for aniso metric, 0 for iso one * * \return 0 if fail, 1 if succeed. @@ -845,8 +845,8 @@ int MMGS_solTruncatureForOptim(MMG5_pMesh mesh, MMG5_pSol met,int ani) { /** - * \param mesh pointer toward the mesh - * \param met pointer toward the metric + * \param mesh pointer to the mesh + * \param met pointer to the metric * * \return 1 if succeed, 0 if fail * @@ -920,7 +920,7 @@ int MMGS_doSol_iso(MMG5_pMesh mesh,MMG5_pSol met) { } /** - * \param mesh pointer toward the mesh + * \param mesh pointer to the mesh * \param k index of starting triangle * \param i local index of point \a p1 in \a k * \param p1 point on which we want to compute the 3D unit tensor @@ -1031,7 +1031,7 @@ int MMGS_unitTensor_3D( MMG5_pMesh mesh,MMG5_int k,int i,MMG5_pPoint p1,double * } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param p0 starting point * \param k index of starting element * \param i local index of \a p0 in \a k @@ -1131,7 +1131,7 @@ int MMGS_surfopenballRotation(MMG5_pMesh mesh,MMG5_pPoint p0,MMG5_int k, int i, } /** - * \param mesh pointer toward the mesh + * \param mesh pointer to the mesh * \param k index of starting triangle * \param i local index of point \a p1 in \a k * \param p1 point on which we want to compute the 3D unit tensor @@ -1319,8 +1319,8 @@ int MMGS_unitTensor_2D ( MMG5_pMesh mesh,MMG5_int k,int i,MMG5_pPoint p1, /** - * \param mesh pointer toward the mesh - * \param met pointer toward the metric + * \param mesh pointer to the mesh + * \param met pointer to the metric * * \return 1 if succeed, 0 if fail * diff --git a/src/mmgs/librnbg_s.c b/src/mmgs/librnbg_s.c index 63bdcdc62..25c237c10 100644 --- a/src/mmgs/librnbg_s.c +++ b/src/mmgs/librnbg_s.c @@ -38,8 +38,8 @@ #include "librnbg_private.h" /** - * \param trias pointer toward a table containing the tetra structures. - * \param *perm pointer toward the permutation table (to perform in place + * \param trias pointer to a table containing the tetra structures. + * \param *perm pointer to the permutation table (to perform in place * permutations). * \param ind1 index of the first tria to swap. * \param ind2 index of the second tria to swap. @@ -65,9 +65,9 @@ void MMG5_swapTri(MMG5_pTria trias, MMG5_int* perm, MMG5_int ind1, MMG5_int ind2 /** * \param boxVertNbr number of vertices by box. - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the solution structure - * \param fields pointer toward an array of solution fields + * \param mesh pointer to the mesh structure. + * \param sol pointer to the solution structure + * \param fields pointer to an array of solution fields * \param permNodGlob array to store the global permutation of nodes (if provided) * * \return 0 if the renumbering fail and we can't rebuild tetrahedra hashtable, diff --git a/src/mmgs/mmgs.c b/src/mmgs/mmgs.c index 288fbe3ef..917931731 100644 --- a/src/mmgs/mmgs.c +++ b/src/mmgs/mmgs.c @@ -52,8 +52,8 @@ static void MMG5_endcod(void) { /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the sol structure. * \return 1. * * Read local parameters file. This file must have the same name as @@ -201,7 +201,7 @@ static int MMGS_parsop(MMG5_pMesh mesh,MMG5_pSol met) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \return 1 if success, 0 otherwise. * * Write a DEFAULT.mmg3d file containing the default values of parameters that @@ -253,9 +253,9 @@ int MMGS_writeLocalParam( MMG5_pMesh mesh ) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward a sol structure (metric). - * \param sol pointer toward a sol structure (metric). + * \param mesh pointer to the mesh structure. + * \param met pointer to a sol structure (metric). + * \param sol pointer to a sol structure (metric). * * \return \ref MMG5_SUCCESS if success, \ref MMG5_LOWFAILURE if failed * but a conform mesh is saved and \ref MMG5_STRONGFAILURE if failed and we diff --git a/src/mmgs/mmgs1.c b/src/mmgs/mmgs1.c index 4de5506fc..e619e8527 100644 --- a/src/mmgs/mmgs1.c +++ b/src/mmgs/mmgs1.c @@ -40,10 +40,10 @@ extern int8_t ddb; /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k element index. - * \param vx pointer toward table of edges to split. + * \param vx pointer to table of edges to split. * \return 1. * * Find acceptable position for splitting. @@ -143,8 +143,8 @@ int MMGS_dichoto(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int k,MMG5_int *vx) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param iel index of the starting triangle. * \param ia local index of the edge to split in \a k. * \param ip index of the point that we try to create. @@ -391,7 +391,7 @@ int chkedg(MMG5_pMesh mesh,MMG5_int iel) { } /** - * \param met pointer toward met structure + * \param met pointer to met structure * \param typchk type of check to perform: 1 for first stage (adaptation to * capture roughly the surface mesh), 2 for second stage of adaptation * (rough capture of input metric). @@ -431,7 +431,7 @@ static int swpmsh(MMG5_pMesh mesh,MMG5_pSol met,int8_t typchk) { MMG5_int k,ns,nns; int8_t i; - /* Local function pointer toward the suitable functions to use for edge length + /* Local function pointer to the suitable functions to use for edge length * and quality computation depending on the adaptation phase */ double (*MMGS_lenEdg)(MMG5_pMesh mesh,MMG5_pSol sol ,MMG5_int ,MMG5_int, int8_t ) = NULL; double (*MMGS_caltri)(MMG5_pMesh mesh,MMG5_pSol sol ,MMG5_pTria pt ) = MMG5_caltri_iso; @@ -526,8 +526,8 @@ static int movtri(MMG5_pMesh mesh,MMG5_pSol met,int maxit) { } /** - * \param mesh pointer toward the mesh structure. - * \param hash pointer toward the hash table of edges. + * \param mesh pointer to the mesh structure. + * \param hash pointer to the hash table of edges. * \return 0 if failed, 1 if success * * Delete the points inserted by pattern if the pattern step fail. @@ -567,8 +567,8 @@ int MMGS_delPatternPts(MMG5_pMesh mesh,MMG5_Hash hash) } /** - * \param mesh pointer toward the mesh - * \param met pointer toward the metric + * \param mesh pointer to the mesh + * \param met pointer to the metric * \param typchk type of check performed depending on the remeshing step * * \return -1 if fail, the number of split otherwise @@ -941,8 +941,8 @@ static int anaelt(MMG5_pMesh mesh,MMG5_pSol met,int8_t typchk) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k index of element to split. * \param i index of edge to split. * \return -1 if lack of memory, 0 if the edge should not be split and 1 @@ -1013,8 +1013,8 @@ MMG5_int chkspl(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int k,int i) { } /** - * \param mesh pointer toward mesh structure - * \param met pointer toward met structure + * \param mesh pointer to mesh structure + * \param met pointer to met structure * \param typchk type of check to perform: 1 for first stage (adaptation to * capture roughly the surface mesh), 2 for second stage of adaptation * (rough capture of input metric). @@ -1031,7 +1031,7 @@ static MMG5_int colelt(MMG5_pMesh mesh,MMG5_pSol met,int8_t typchk) { int l,isloc,ier,ilist; int8_t i,i1,i2; - /* Local function pointer toward the suitable functions to use for edge length + /* Local function pointer to the suitable functions to use for edge length * and quality computation depending on the adaptation phase */ double (*MMGS_lenEdg)(MMG5_pMesh mesh,MMG5_pSol sol ,MMG5_int ,MMG5_int, int8_t ) = NULL; double (*MMGS_caltri)(MMG5_pMesh mesh,MMG5_pSol sol ,MMG5_pTria pt ) = MMG5_caltri_iso; @@ -1121,8 +1121,8 @@ static MMG5_int colelt(MMG5_pMesh mesh,MMG5_pSol met,int8_t typchk) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * * \return -1 if failed or number of new points. * @@ -1197,8 +1197,8 @@ static MMG5_int adpspl(MMG5_pMesh mesh,MMG5_pSol met) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \return -1 if failed. * \return number of deleted points. * @@ -1451,8 +1451,8 @@ static int anatri(MMG5_pMesh mesh,MMG5_pSol met,int8_t typchk) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param permNodGlob if provided, strore the global permutation of nodes. * \return 0 if failed, 1 if success. * diff --git a/src/mmgs/mmgs2.c b/src/mmgs/mmgs2.c index 52e8dcd27..0b68f1585 100644 --- a/src/mmgs/mmgs2.c +++ b/src/mmgs/mmgs2.c @@ -36,9 +36,9 @@ #include "mmgexterns_private.h" /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the level-set values. - * \param met pointer toward a metric (non-mandatory). + * \param mesh pointer to the mesh structure. + * \param sol pointer to the level-set values. + * \param met pointer to a metric (non-mandatory). * \return 1 if success, 0 otherwise. * * Proceed to discretization of the implicit function carried by sol into mesh, @@ -229,9 +229,9 @@ static int MMGS_cuttri(MMG5_pMesh mesh, MMG5_pSol sol,MMG5_pSol met){ } /** - * \param mesh pointer toward the mesh structure. - * \param sol pointer toward the level-set - * \param met pointer toward a metric (optionnal) + * \param mesh pointer to the mesh structure. + * \param sol pointer to the level-set + * \param met pointer to a metric (optionnal) * * \return 0 if fail, 1 otherwise. * diff --git a/src/mmgs/movpt_s.c b/src/mmgs/movpt_s.c index 331d9066a..4452edfcd 100644 --- a/src/mmgs/movpt_s.c +++ b/src/mmgs/movpt_s.c @@ -39,9 +39,9 @@ #include "mmgexterns_private.h" /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. - * \param list pointer toward the ball of the point. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. + * \param list pointer to the ball of the point. * \param ilist size of the ball. * * \return 0 if we can't move the point, 1 if we can. @@ -358,7 +358,7 @@ int movintpt_iso(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int *list,int ilist) { } /** - * \param mesh pointer toward the mesh + * \param mesh pointer to the mesh * \param it triangle to which belongs the edge along which we move * \param isrid 1 if the edge is a ridge * \param ip0 edge point that we want to move @@ -423,7 +423,7 @@ int MMGS_paramDisp(MMG5_pMesh mesh,MMG5_int it,int8_t isrid,MMG5_int ip0,MMG5_in } /** - * \param mesh pointer toward the mesh + * \param mesh pointer to the mesh * \param p0 point to move. * \param p neighbouring point toward which we try to move. * \param llold init length of edge p0-p @@ -535,7 +535,7 @@ int MMGS_update_normalAndTangent(MMG5_pMesh mesh,MMG5_pPoint p0,MMG5_pPoint p, } /** - * \param mesh pointer toward the mesh + * \param mesh pointer to the mesh * \param p0 point to move. * \param p neighbouring point toward which we try to move. * \param llold init length of edge p0-p diff --git a/src/mmgs/quality_s.c b/src/mmgs/quality_s.c index 7d5fba89b..89332342b 100644 --- a/src/mmgs/quality_s.c +++ b/src/mmgs/quality_s.c @@ -41,8 +41,8 @@ extern int8_t ddb; /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param iel element index * \return 0 if fail, -1 if orientation is reversed with regards to orientation * of vertices, the computed quality otherwise. @@ -271,8 +271,8 @@ inline double diamelt(MMG5_pPoint p0,MMG5_pPoint p1,MMG5_pPoint p2) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param metRidTyp Type of storage of ridges metrics: 0 for classic storage, * 1 for special storage. * \return 0 if fail, 1 otherwise. @@ -388,8 +388,8 @@ int MMGS_prilen(MMG5_pMesh mesh, MMG5_pSol met, int metRidTyp) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \return 0 if the worst element has a nul quality, 1 otherwise. * * Print histogram of mesh qualities for classical storage of ridges @@ -456,8 +456,8 @@ int MMGS_inqua(MMG5_pMesh mesh,MMG5_pSol met) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \return 0 if the worst element has a nul quality, 1 otherwise. * * Print histogram of mesh qualities for special storage of ridges metrics diff --git a/src/mmgs/split_s.c b/src/mmgs/split_s.c index add7f1740..1c616d65b 100644 --- a/src/mmgs/split_s.c +++ b/src/mmgs/split_s.c @@ -37,8 +37,8 @@ #include "mmgexterns_private.h" /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k index of element to split. * \param i index of edge to split. * \param vx \f$vx[i]\f$ is the index of the point to add on the edge \a i. @@ -96,8 +96,8 @@ int MMGS_split1_sim(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int k,int i,MMG5_int *vx) } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k index of element to split. * \param i index of edge to split. * \param vx \f$vx[i]\f$ is the index of the point to add on the edge \a i. @@ -144,8 +144,8 @@ int MMGS_split1(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int k,int i,MMG5_int *vx) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k index of the starting triangle. * \param i local index of the edge to split in \a k. * \param ip index of the point that we try to create. @@ -269,7 +269,7 @@ int MMGS_simbulgept(MMG5_pMesh mesh,MMG5_pSol met, MMG5_int k,int i,MMG5_int ip) } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * \param k index of element to split. * \param i index of edge to split. * \param ip index of the new point. @@ -369,8 +369,8 @@ int split1b(MMG5_pMesh mesh,MMG5_int k,int8_t i,MMG5_int ip) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k index of element to split. * \param vx \f$vx[i]\f$ is the index of the point to add on the edge \a i. * \return 0 if split leads to invalid element, else 1. @@ -447,8 +447,8 @@ int MMG5_split2_sim(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int k,MMG5_int *vx) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k index of element to split. * \param vx \f$vx[i]\f$ is the index of the point to add on the edge \a i. * \return 1 if success, 0 if fail. @@ -519,8 +519,8 @@ int MMGS_split2(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int k,MMG5_int *vx) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k index of element to split. * \param vx \f$vx[i]\f$ is the index of the point to add on the edge \a i. * \return 0 if split leads to invalid element, else 1. @@ -608,8 +608,8 @@ int MMGS_split3_sim(MMG5_pMesh mesh,MMG5_pSol met,MMG5_int k,MMG5_int *vx) { } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the metric structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the metric structure. * \param k index of element to split. * \param vx \f$vx[i]\f$ is the index of the point to add on the edge \a i. * \return 1 if success, 0 if fail. diff --git a/src/mmgs/swapar_s.c b/src/mmgs/swapar_s.c index cc42814af..61f480a73 100644 --- a/src/mmgs/swapar_s.c +++ b/src/mmgs/swapar_s.c @@ -39,15 +39,15 @@ #include "inlined_functions_private.h" /** - * \param mesh pointer toward the mesh - * \param met pointer toward the metric + * \param mesh pointer to the mesh + * \param met pointer to the metric * \param k index of the element in wich we perform the edge swap * \param i index of the edge to swap * \param typchk type of check to perform - * \param MMGS_lenEdg pointer toward the suitable fct to compute edge lengths + * \param MMGS_lenEdg pointer to the suitable fct to compute edge lengths * depending on presence of input metric, metric type (iso/aniso) and \a typchk * value (i.e. stage of adaptation) - * \param MMGS_caltri pointer toward the suitable fct to compute tria quality + * \param MMGS_caltri pointer to the suitable fct to compute tria quality * depending on presence of input metric, metric type (iso/aniso) and \a typchk * value (i.e. stage of adaptation) * diff --git a/src/mmgs/variadic_s.c b/src/mmgs/variadic_s.c index 6c46fe41d..210b57766 100644 --- a/src/mmgs/variadic_s.c +++ b/src/mmgs/variadic_s.c @@ -42,9 +42,9 @@ #include "mmgsexterns_private.h" /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward the sol structure. - * \param ls pointer toward the sol structure. + * \param mesh pointer to the mesh structure. + * \param met pointer to the sol structure. + * \param ls pointer to the sol structure. * * \return 0 if fail, 1 if success * @@ -74,9 +74,9 @@ int MMGS_Alloc_mesh(MMG5_pMesh *mesh, MMG5_pSol *met, MMG5_pSol *ls) { return 1; } /** - * \param mesh pointer toward the mesh structure. - * \param met pointer toward a sol structure (metric). - * \param ls pointer toward the level-set (in ls-mode). + * \param mesh pointer to the mesh structure. + * \param met pointer to a sol structure (metric). + * \param ls pointer to the level-set (in ls-mode). * * Initialization of mesh and solution structures to their default * values (default names, versions, dimensions...). @@ -129,11 +129,11 @@ void MMGS_Init_woalloc_mesh(MMG5_pMesh mesh, MMG5_pSol *met,MMG5_pSol *ls ) { * structure must follow one of the \a MMG5_ARG* preprocessor variable that allow * to identify it. * - * \a argptr contains at least a pointer toward a \a MMG5_pMesh structure + * \a argptr contains at least a pointer to a \a MMG5_pMesh structure * (that will contain the mesh and identified by the MMG5_ARG_ppMesh keyword). * * To call the \a MMGS_mmgslib function, you must also provide - * a pointer toward a \a MMG5_pSol structure (that will contain the ouput + * a pointer to a \a MMG5_pSol structure (that will contain the ouput * metric (and the input one, if provided) and identified by the MMG5_ARG_ppMet * keyword). * @@ -202,11 +202,11 @@ int MMGS_Init_mesh_var( va_list argptr ) { * structure must follow one of the \a MMG5_ARG preprocessor variable that allow to * identify it. * - * \a argptr contains at least a pointer toward a \a MMG5_pMesh structure + * \a argptr contains at least a pointer to a \a MMG5_pMesh structure * (that will contain the mesh and identified by the MMG5_ARG_ppMesh keyword). * * To call the \a MMGS_mmgslib function, you must also provide - * a pointer toward a \a MMG5_pSol structure (that will contain the ouput + * a pointer to a \a MMG5_pSol structure (that will contain the ouput * metric (and the input one, if provided) and identified by the MMG5_ARG_ppMet * keyword). * @@ -300,11 +300,11 @@ int MMGS_Free_all_var(va_list argptr) * structure must follow one of the \a MMG5_ARG* preprocessor variable that allow * to identify it. * - * \a argptr contains at least a pointer toward a \a MMG5_pMesh structure + * \a argptr contains at least a pointer to a \a MMG5_pMesh structure * (that will contain the mesh and identified by the MMG5_ARG_ppMesh keyword). * * To call the \a MMGS_mmgslib function, you must also provide - * a pointer toward a \a MMG5_pSol structure (that will contain the ouput + * a pointer to a \a MMG5_pSol structure (that will contain the ouput * metric (and the input one, if provided) and identified by the MMG5_ARG_ppMet * keyword). * @@ -401,12 +401,12 @@ int MMGS_Free_structures_var(va_list argptr) * name. Each structure must follow one of the \a MMG5_ARG preprocessor variable * that allow to identify it. * - * \a argptr contains at least a pointer toward a \a MMG5_pMesh + * \a argptr contains at least a pointer to a \a MMG5_pMesh * structure (that will contain the mesh and identified by the MMG5_ARG_ppMesh * keyword). * * To call the \a MMGS_mmgslib function, you must also provide - * a pointer toward a \a MMG5_pSol structure (that will contain the ouput + * a pointer to a \a MMG5_pSol structure (that will contain the ouput * metric (and the input one, if provided) and identified by the MMG5_ARG_ppMet * keyword). * diff --git a/src/mmgs/zaldy_s.c b/src/mmgs/zaldy_s.c index 581eb46c6..cb1ea4ff4 100644 --- a/src/mmgs/zaldy_s.c +++ b/src/mmgs/zaldy_s.c @@ -82,7 +82,7 @@ MMG5_int MMGS_newElt(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh + * \param mesh pointer to the mesh * \param iel index of the element to delete * * \return 1 if success, 0 if fail @@ -110,7 +110,7 @@ int MMGS_delElt(MMG5_pMesh mesh,MMG5_int iel) { } /** - * \param mesh pointer toward the mesh structure + * \param mesh pointer to the mesh structure * * \return 0 if fail, 1 otherwise * @@ -195,7 +195,7 @@ int MMGS_memOption_memSet(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh structure + * \param mesh pointer to the mesh structure * * \return 0 if fail, 1 otherwise * @@ -213,7 +213,7 @@ int MMGS_memOption(MMG5_pMesh mesh) { } /** - * \param mesh pointer toward the mesh structure. + * \param mesh pointer to the mesh structure. * * \return 0 if failed, 1 otherwise. * @@ -253,7 +253,7 @@ int MMGS_setMeshSize_alloc( MMG5_pMesh mesh ) { } /** - * \param mesh pointer toward the mesh + * \param mesh pointer to the mesh * * \return 1 if success, 0 if fail * From fc72a0fd72a804aaa6092d6a8059a705780cd915 Mon Sep 17 00:00:00 2001 From: Mark Potse Date: Sat, 2 Mar 2024 22:41:03 +0100 Subject: [PATCH 03/11] use MathJax by default, added some info about making doc, language fixes in README.md --- README.md | 83 +++++++++++++++++++++-------------------- doc/doxygen/Doxyfile.in | 2 +- src/mmg3d/libmmg3d.h | 1 - 3 files changed, 43 insertions(+), 43 deletions(-) diff --git a/README.md b/README.md index f61ca380c..6b3ba58a6 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,7 @@ --- Mmg provides 3 applications and 4 libraries: - * the **mmg2d** application and library: mesh generation from a set of edges, adaptation and optimization of a bidimensionnal triangulation and isovalue discretization; + * the **mmg2d** application and library: mesh generation from a set of edges, adaptation and optimization of a bidimensional triangulation, and isovalue discretization; * the **mmgs** application and library: adaptation and optimization of a surface triangulation and isovalue discretization; * the **mmg3d** application and library: adaptation and optimization of a tetrahedral mesh, isovalue discretization and lagrangian movement; * the **mmg** library gathering the **mmg2d**, **mmgs** and **mmg3d** libraries. @@ -71,9 +71,9 @@ Mmg provides 3 applications and 4 libraries: ### Needed tools To get and build Mmg, you will need: * **Git**: to download the code you will have to use a git manager. You can install a git manager from the link below but there are many other git clients that you can use: - * [Official Git client](https://git-scm.com/download) (command line program) + * [Official Git client](https://git-scm.com/download) (command-line program) * [GitKraken](https://www.gitkraken.com/) - * [SourceTree](https://www.sourcetreeapp.com/) + * [SourceTree](https://www.sourcetreeapp.com/) Note that if you uses Microsoft Visual Studio (Windows OS), you can simply activate the Git Module of the application. @@ -85,12 +85,12 @@ To get and build Mmg, you will need: ``` Add CMake to the system PATH for all users ``` - + ### Mmg download and compilation #### Unix-like OS (Linux, MacOS...) - 1. Get the repository: + 1. Get the repository: ``` wget https://github.com/MmgTools/mmg/archive/master.zip ``` @@ -103,24 +103,24 @@ To get and build Mmg, you will need: * **src/mmg2d/** for files related to the mmg2d application; * **src/mmgs/** for files related to the mmgs application; * **src/mmg3d/** for files related to the mmg3d application; - * **src/common/** for files related to the both. + * **src/common/** for files related to all three. - 2. Fast compilation (build both **mmg2d**, **mmgs**, **mmg3d**, the mmg2d static library (**libmmg3d.a**), the mmgs static library (**libmmgs.a**), the mmg3d static library (**libmmg3d.a**) and the mmg static library (**libmmg.a**)): + 2. Fast compilation (build **mmg2d**, **mmgs**, **mmg3d**, the mmg2d static library (**libmmg3d.a**), the mmgs static library (**libmmgs.a**), the mmg3d static library (**libmmg3d.a**) and the mmg static library (**libmmg.a**)) all at once: ``` - cd mmg - mkdir build - cd build - cmake .. - make + cd mmg + mkdir build + cd build + cmake .. + make make install ``` - If the `make install` command fail, try to run the `sudo make install` command. - If you don't have root access, please refers to the [Installation section](https://github.com/MmgTools/Mmg/wiki/Setup-guide#iii-installation) of the [setup guide](https://github.com/MmgTools/Mmg/wiki/Setup-guide#setup-guide). + If the `make install` command fails, try to run the `sudo make install` command. + If you don't have root access, please refer to the [Installation section](https://github.com/MmgTools/Mmg/wiki/Setup-guide#iii-installation) of the [setup guide](https://github.com/MmgTools/Mmg/wiki/Setup-guide#setup-guide). - The **mmg2d**, **mmgs** and **mmg3d** applications are available under the `mmg2d_O3`, `mmgs_O3` and `mmg3d_O3` commands. + The **mmg2d**, **mmgs** and **mmg3d** applications are available under the `mmg2d_O3`, `mmgs_O3` and `mmg3d_O3` commands. -Note that if you use some specific options and want to set it easily, you can use a shell script to execute the previous commands. An example is provided [here](https://github.com/MmgTools/mmg/wiki/Configure-script-for-CMake-(UNIX-like-OS)). +Note that if you use some specific options and want to set them easily, you can use a shell script to execute the previous commands. An example is provided [here](https://github.com/MmgTools/mmg/wiki/Configure-script-for-CMake-(UNIX-like-OS)). #### Windows OS The following compilation can be performed in any modern version of *Windows* @@ -144,20 +144,19 @@ Universal windows platform development cmake -G "Visual Studio 15 2017 Win64" ^ configure ``` - - Note that you can use a script to make this step easier (an example of script is provided [here](https://github.com/MmgTools/mmg/wiki/Configure-script-for-CMake-(Windows-OS))). - + + Note that you can use a script to make this step easier (an example of script is provided [here](https://github.com/MmgTools/mmg/wiki/Configure-script-for-CMake-(Windows-OS))). + Once the configuration script has finished without errors a `mmg.sln` file will be generated in the cmake_build directory. - 6. Double click this file and the visual studio project will open. Then choose the project configuration (Release, Debug...). - Please, make sure that the project is set to Win32 or x64 and change it if is not. + 6. Double click this file and the visual studio project will open. Then choose the project configuration (Release, Debug...) and make sure that the project is set to Win32 or x64. Finally, in order to compile Mmg, right click the `INSTALL` project and select the option `BUILD`. ##### Compile with MinGW - 1. Get a **C Compiler**: + 1. Get a **C Compiler**: * **MinGW** can be downloaded [here](http://mingw.org/). We recommand to install the *mingw-developer-tools*, *mingw32-base*, *mingw32-gcc-fortran*, *mingw32-gcc-g++* and *msys-base* packages; - * Edit the environment variables and add MinGW in your **PATH** variable. It can be done in the **advanced system settings** panel. (note that you must modify the **PATH** variable, not the **Path** one); + * Edit the environment variables and add MinGW in your **PATH** variable. It can be done in the **advanced system settings** panel. (note that you must modify the **PATH** variable, not **Path**); * **MinGW** binaries are probably in `C:\MinGW\bin` * the MinGW terminal is in `C:\MinGW\msys\1.0\msys` @@ -169,42 +168,44 @@ Universal windows platform development mingw32-make ``` -Again, if you use some specific options and want to make the CMake configuration step easier, you can use a batch script. An example of script is provided [here](https://github.com/MmgTools/mmg/wiki/Configure-script-for-CMake-(Windows-OS)). +Again, if you use some specific options and want to make the CMake configuration step easier, you can use a batch script. An example script is provided [here](https://github.com/MmgTools/mmg/wiki/Configure-script-for-CMake-(Windows-OS)). ## Documentation -### Project's web page -Project's actualities and software tutorials can be found on the [mmgtools](http://www.mmgtools.org) web page. +### Project web page +Actualities of the project and software tutorials can be found on the [mmgtools](http://www.mmgtools.org) web page. -### Mmg's forum +### Forum Share your comments and issues with other members of the Mmg community on the [Mmg forum](https://forum.mmgtools.org/). -### GitHub's Wiki -More detailed informations about the compilation and configuration of the mmg's applications are available on the project [wiki](https://github.com/MmgTools/mmg/wiki). +### GitHub Wiki +More detailed information about the compilation and configuration of Mmg applications is available on the project [wiki](https://github.com/MmgTools/mmg/wiki). -### Man-pages +### Man pages Man pages are available inside the **doc/man** directory: - * To see the **mmg2d** man page, just tap `man ./doc/man/mmg2d.1.gz` - * To see the **mmgs** man page, just tap `man ./doc/man/mmgs.1.gz` - * To see the **mmg3d** man page, just tap `man ./doc/man/mmg3d.1.gz` + * To see the **mmg2d** man page, just run `man ./doc/man/mmg2d.1.gz` + * To see the **mmgs** man page, run `man ./doc/man/mmgs.1.gz` + * To see the **mmg3d** man page, run `man ./doc/man/mmg3d.1.gz` ### Code documentation -Run the `make doc` command to build the Doxygen documentation. - * To see the **mmg2d** documentation, open up the **mmg/doc/mmg2d/html/index.html** file; - * To see the **mmgs** documentation, open up the **mmg/doc/mmgs/html/index.html** file; - * To see the **mmg3d** documentation, open up the **mmg/doc/mmg3d/html/index.html** file. +Run the `make doc` command to build the Doxygen documentation, after running `cmake` + with the option `-DBUILD_DOC=yes` if you did not already do so. + You may wish to adapt `build/Doxyfile` to your liking. + * To see the **mmg2d** documentation, open the file **mmg/doc/mmg2d/html/index.html**, + * to see the **mmgs** documentation, open **mmg/doc/mmgs/html/index.html**, and + * ro see the **mmg3d** documentation, open **mmg/doc/mmg3d/html/index.html**. ## Platforms -The **mmg** applications are validated on OS X and on most of the Linux platforms. +The **mmg** applications are tested on OS X and on most of the Linux platforms. ## Contributing -Your contributions to the **mmg** project are welcomed. You can help us to improve +Your contributions to the **mmg** project are welcome. You can help us to improve our code by many means: - * pull requests: please follow the [wiki's guideline](https://github.com/MmgTools/Mmg/wiki/Developers-wiki#pull-requests); + * pull requests: please follow the [guidelines on the wiki](https://github.com/MmgTools/Mmg/wiki/Developers-wiki#pull-requests); * feature requests: please use the [Mmg forum](https://forum.mmgtools.org/); * bug reports: please use the [GitHub issue tracker](https://github.com/MmgTools/mmg/issues/new); ## About the team -mmg's current developers and maintainers are Charles Dapogny, Cécile Dobrzynski, Pascal Frey and Algiane Froehly. +Mmg's current developers and maintainers are Charles Dapogny, Cécile Dobrzynski, Pascal Frey and Algiane Froehly. Contact: contact@mmgtools.org diff --git a/doc/doxygen/Doxyfile.in b/doc/doxygen/Doxyfile.in index 629e2479f..18c8daa9c 100644 --- a/doc/doxygen/Doxyfile.in +++ b/doc/doxygen/Doxyfile.in @@ -1374,7 +1374,7 @@ FORMULA_TRANSPARENT = YES # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. -USE_MATHJAX = NO +USE_MATHJAX = YES # When MathJax is enabled you can set the default output format to be used for # the MathJax output. See the MathJax site (see: diff --git a/src/mmg3d/libmmg3d.h b/src/mmg3d/libmmg3d.h index 3d3a85a37..c0f6b1b96 100644 --- a/src/mmg3d/libmmg3d.h +++ b/src/mmg3d/libmmg3d.h @@ -389,7 +389,6 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara * \brief Set vertex coordinates and references in a mesh structure * * \param mesh pointer to the mesh structure. - * vertices[(i-1)*3]\@3. * \param vertices array of vertex coordinates in the order \f$[x_1, y_1, z_1, x_2, \ldots, z_N]\f$ * where \f$N\f$ is the number of vertices in the mesh. * \param refs array of point references. From bcf6eb2475f6844a8760b6214de1b261b9b2b3ff Mon Sep 17 00:00:00 2001 From: Mark Potse Date: Sat, 2 Mar 2024 23:19:36 +0100 Subject: [PATCH 04/11] fixes in the Developers guide --- CONTRIBUTING.md | 38 ++++++++++++++++++++------------------ 1 file changed, 20 insertions(+), 18 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 822152b86..cb4b60109 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,15 +1,15 @@ # Developers guide -## I/ Documents your code using Doxygen +## I/ Documenting your code using Doxygen ### 1) How #### General case -Our project use **Doxygen** to automatically generate the developer documentation. If you implement a new function in **Mmg**, please, comment it and give at least its interface description (function's arguments and return values). +Our project use **Doxygen** to automatically generate the developer documentation. If you implement a new function in **Mmg**, please, comment it and give at least its interface description (function arguments and return values). -For example a minimal documentation for the function that save the mesh may be this one: +For example a minimal documentation for the function that saves the mesh may be this one: ``` /** - * \param mesh pointer toward the mesh structure. - * \param filename pointer toward the name of file. + * \param mesh pointer to the mesh structure. + * \param filename pointer to the name of the file. * \return 0 if failed, 1 otherwise. * * Save mesh data. @@ -19,19 +19,19 @@ For example a minimal documentation for the function that save the mesh may be t */ int MMG3D_saveMesh(MMG5_pMesh mesh, char *filename); ``` -Additionaly, it is a good practice to include text inside the routine to explain the work carried out. +Additionaly, it is good practice to include text inside the routine to explain the work carried out. You can refer to the [Doxygen documentation](http://www.stack.nl/~dimitri/doxygen/) for a description of the **Doxygen** commands. -#### API's functions -Because the library header for Fortran users is automatically generated from the C header, you must add to your documentation the interface of the fortran function. Each line of this interface must begin with the `>` symbol and end with the `\n` one. +#### API functions +Because the library header for Fortran users is automatically generated from the C header, you must add the interface of the fortran function to your documentation. Each line of this interface must begin with the `>` symbol and end with `\n` (a backslash and the letter n). -For example, if the previous function is an API function, its documentation becames the following: +For example, if the previous function is an API function, its documentation becomes the following: ``` /** - * \param mesh pointer toward the mesh structure. - * \param filename pointer toward the name of file. + * \param mesh pointer to the mesh structure. + * \param filename pointer to the name of file. * \return 0 if failed, 1 otherwise. * * Save mesh data. @@ -49,17 +49,17 @@ For example, if the previous function is an API function, its documentation beca * */ int MMG3D_saveMesh(MMG5_pMesh mesh, char *filename); -``` +``` ### 2) Where -Please, comments only your functions in the `.c` file, except for the **API**'s functions that must be documentated in the suitable `libmmg.h` file (and only here). +Please, comments only your functions in the `.c` file, except for the **API** functions; these must be documentated in the appropriate `libmmg.h` file (and only there). ## II/ Memory management: dynamic allocations and deallocations -We need to control the memory consumption in our applications so the memory used by dynamic allocations is counted and updated at each allocation and deallocation. +We need to control the memory consumption in our applications so the memory used by dynamic allocations is counted and updated at each allocation and deallocation. Note that with a high verbosity (at least 6), you can check that at the end of the process the memory count is 0. -To make the update of memory consumption easier, we have wrapped the `malloc`, `calloc`, `realloc` and `free` functions into macros that must be called in place of the matching function. +To make the update of memory consumption easier, we have wrapped the `malloc`, `calloc`, `realloc` and `free` functions into macros that must be called in place of these functions. | `C function` | `Mmg macro` | |----------------------|-----------------------------------| @@ -68,7 +68,7 @@ To make the update of memory consumption easier, we have wrapped the `malloc`, ` | `ptr = (type *) realloc(ptr,size*sizeof(type));`
`if ( high_verbosity )`
    `printf(" ## Warning:%s:%d: %s reallocation.\n",__FILE__,__LINE__,tab_info);`| `MMG5_SAFE_REALLOC(ptr,prevSize,newSize,type,tab_name,law);` | | `Decrease_memory_count(size); `
`free(ptr); ptr = NULL; `| `MMG5_DEL_MEM(mesh,ptr)`| -Note that other macros which aims to help to manage the memory have been implemented. +Note that other macros which aim to help to manage the memory have been implemented. ### 1) Allocations To check that we have enough memory to allocate a pointer of size `siz` and to increment the memory counter, you must precede your allocation by a call to the `MMG5_ADD_MEM(mesh, siz, "tab_name", law)` macro. @@ -89,6 +89,8 @@ MMG5_ADD_MEM(mesh,5*sizeof(double),"my array",exit(EXIT_FAILURE)); MMG5_SAFE_MALLOC(ptr,5,double,exit(EXIT_FAILURE)); ``` +That said, calling `exit` from a library function is not polite. You may wish to do something else in the `law` argument, for example setting a flag that tells your function to free any memory it allocated and return a value indicating failure. + ### 2) Deallocations To decrement the memory counter, to deallocate your pointer and to leave it pointing toward `NULL`, you just need to call the `MMG5_DEL_MEM(mesh,ptr)` macro. @@ -113,5 +115,5 @@ Please, use the following configuration in your editor: Besides, try to respect the following rules: * declaration of variables in the top of the function; * do not use exit(), use a return value instead; - * do not implement void API function; - * the main library functions returns `MMG_SUCCESS` if success, `MMG_LOWFAILURE` if fails but we can save the mesh, `MMG_STRONGFAILURE` if fails and we can't save a conform mesh; + * do not implement void API functions; + * the main library functions returns `MMG_SUCCESS` if successful, `MMG_LOWFAILURE` if the function fails but we can save the mesh, and `MMG_STRONGFAILURE` if fails and we can't save a conforming mesh. From c0d7f12fbe9d1fbdda4264d51e7ae46854bbb5fc Mon Sep 17 00:00:00 2001 From: Mark Potse Date: Sun, 3 Mar 2024 10:42:34 +0100 Subject: [PATCH 05/11] suppress the copyright headers from the example code where it appears in the documentation of libmmg3d.h Tested two methods: \dontinclude with tags, and simply turning those comment blocks into Doxygen blocks with /** ... **/ Rationale: these comment blocks are distracting, they suggest that it concerns Mmg (internal) code, and the F90 examples also don't have them. --- .../IsosurfDiscretization_lsAndMetric/main.c | 10 ++--- .../mmg3d/LagrangianMotion_example0/main.c | 8 ++-- .../adaptation_example0/example0_a/main.c | 8 ++-- .../adaptation_example0/example0_b/main.c | 4 +- libexamples/mmg3d/adaptation_example1/main.c | 44 +++++++++---------- libexamples/mmg3d/adaptation_example2/main.c | 4 +- src/mmg3d/libmmg3d.h | 10 ++--- 7 files changed, 44 insertions(+), 44 deletions(-) diff --git a/libexamples/mmg3d/IsosurfDiscretization_lsAndMetric/main.c b/libexamples/mmg3d/IsosurfDiscretization_lsAndMetric/main.c index ce68f41a9..fe62f9ead 100644 --- a/libexamples/mmg3d/IsosurfDiscretization_lsAndMetric/main.c +++ b/libexamples/mmg3d/IsosurfDiscretization_lsAndMetric/main.c @@ -1,4 +1,4 @@ -/* ============================================================================= +/** ============================================================================= ** This file is part of the mmg software package for the tetrahedral ** mesh modification. ** Copyright (c) Bx INP/Inria/UBordeaux/UPMC, 2004- . @@ -19,7 +19,7 @@ ** . Please read their terms carefully and ** use this copy of the mmg distribution only if you accept them. ** ============================================================================= -*/ +**/ /** * Example of use of the mmg3dls function of the mmg3d library: here the user @@ -87,11 +87,11 @@ int main(int argc,char *argv[]) { /** 1) Initialisation of mesh and sol structures */ /* args of InitMesh: * MMG5_ARG_start: we start to give the args of a variadic func - * MMG5_ARG_ppMesh: next arg will be a pointer over a MMG5_pMesh + * MMG5_ARG_ppMesh: next arg will be a pointer to an MMG5_pMesh * &mmgMesh: pointer to your MMG5_pMesh (that stores your mesh) - * MMG5_ARG_ppLs: next arg will be a pointer over a MMG5_pSol storing a level-set + * MMG5_ARG_ppLs: next arg will be a pointer to an MMG5_pSol storing a level-set * &mmgLs: pointer to your MMG5_pSol (that stores your level-set) - * MMG5_ARG_ppMet: next arg will be a pointer over a MMG5_pSol that will + * MMG5_ARG_ppMet: next arg will be a pointer to an MMG5_pSol that will * store the input metric * &mmgMet: pointer to your MMG5_pSol (that will store the input metric) */ mmgMesh = NULL; diff --git a/libexamples/mmg3d/LagrangianMotion_example0/main.c b/libexamples/mmg3d/LagrangianMotion_example0/main.c index 5b0833a8e..9404efeea 100644 --- a/libexamples/mmg3d/LagrangianMotion_example0/main.c +++ b/libexamples/mmg3d/LagrangianMotion_example0/main.c @@ -1,4 +1,4 @@ -/* ============================================================================= +/** ============================================================================= ** This file is part of the mmg software package for the tetrahedral ** mesh modification. ** Copyright (c) Bx INP/Inria/UBordeaux/UPMC, 2004- . @@ -19,7 +19,7 @@ ** . Please read their terms carefully and ** use this copy of the mmg distribution only if you accept them. ** ============================================================================= -*/ +**/ /** * Example of use of the mmg3dmov function of the mmg3d library (basic use of @@ -79,9 +79,9 @@ int main(int argc,char *argv[]) { /** 1) Initialisation of mesh and sol structures */ /* args of InitMesh: * MMG5_ARG_start: we start to give the args of a variadic func - * MMG5_ARG_ppMesh: next arg will be a pointer over a MMG5_pMesh + * MMG5_ARG_ppMesh: next arg will be a pointer to an MMG5_pMesh * &mmgMesh: pointer to your MMG5_pMesh (that stores your mesh) - * MMG5_ARG_ppMet: next arg will be a pointer over a MMG5_pSol storing a metric + * MMG5_ARG_ppMet: next arg will be a pointer to an MMG5_pSol storing a metric * &mmgSol: pointer to your MMG5_pSol (that stores your metric) */ mmgMesh = NULL; mmgSol = NULL; diff --git a/libexamples/mmg3d/adaptation_example0/example0_a/main.c b/libexamples/mmg3d/adaptation_example0/example0_a/main.c index 3729e81ad..eb2e9b323 100644 --- a/libexamples/mmg3d/adaptation_example0/example0_a/main.c +++ b/libexamples/mmg3d/adaptation_example0/example0_a/main.c @@ -19,6 +19,7 @@ ** . Please read their terms carefully and ** use this copy of the mmg distribution only if you accept them. ** ============================================================================= +** */ /** @@ -32,7 +33,7 @@ * \copyright GNU Lesser General Public License. */ -#include +#include /** BEGIN_EXAMPLE (this line is used by Doxygen) */ #include #include #include @@ -41,7 +42,7 @@ #include #include -/** Include the mmg3d library hader file */ +/** Include the mmg3d library header file */ // if the header file is in the "include" directory // #include "libmmg3d.h" // if the header file is in "include/mmg/mmg3d" @@ -151,4 +152,5 @@ int main(int argc,char *argv[]) { fileout = NULL; return(ier); -} +} /** END_EXAMPLE (this line is used by Doxygen) */ + diff --git a/libexamples/mmg3d/adaptation_example0/example0_b/main.c b/libexamples/mmg3d/adaptation_example0/example0_b/main.c index e0a2336de..3c08eca85 100644 --- a/libexamples/mmg3d/adaptation_example0/example0_b/main.c +++ b/libexamples/mmg3d/adaptation_example0/example0_b/main.c @@ -1,4 +1,4 @@ -/* ============================================================================= +/** ============================================================================= ** This file is part of the mmg software package for the tetrahedral ** mesh modification. ** Copyright (c) Bx INP/Inria/UBordeaux/UPMC, 2004- . @@ -19,7 +19,7 @@ ** . Please read their terms carefully and ** use this copy of the mmg distribution only if you accept them. ** ============================================================================= -*/ +**/ /** * Example of use of the mmg3d library (basic use of mesh adaptation) diff --git a/libexamples/mmg3d/adaptation_example1/main.c b/libexamples/mmg3d/adaptation_example1/main.c index f109bf9d4..869279863 100644 --- a/libexamples/mmg3d/adaptation_example1/main.c +++ b/libexamples/mmg3d/adaptation_example1/main.c @@ -1,25 +1,25 @@ -/* ============================================================================= -** This file is part of the mmg software package for the tetrahedral -** mesh modification. -** Copyright (c) Bx INP/Inria/UBordeaux/UPMC, 2004- . -** -** mmg is free software: you can redistribute it and/or modify it -** under the terms of the GNU Lesser General Public License as published -** by the Free Software Foundation, either version 3 of the License, or -** (at your option) any later version. -** -** mmg is distributed in the hope that it will be useful, but WITHOUT -** ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or -** FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public -** License for more details. -** -** You should have received a copy of the GNU Lesser General Public -** License and of the GNU General Public License along with mmg (in -** files COPYING.LESSER and COPYING). If not, see -** . Please read their terms carefully and -** use this copy of the mmg distribution only if you accept them. -** ============================================================================= -*/ +/** ============================================================================= + ** This file is part of the mmg software package for the tetrahedral + ** mesh modification. + ** Copyright (c) Bx INP/Inria/UBordeaux/UPMC, 2004- . + ** + ** mmg is free software: you can redistribute it and/or modify it + ** under the terms of the GNU Lesser General Public License as published + ** by the Free Software Foundation, either version 3 of the License, or + ** (at your option) any later version. + ** + ** mmg is distributed in the hope that it will be useful, but WITHOUT + ** ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + ** FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public + ** License for more details. + ** + ** You should have received a copy of the GNU Lesser General Public + ** License and of the GNU General Public License along with mmg (in + ** files COPYING.LESSER and COPYING). If not, see + ** . Please read their terms carefully and + ** use this copy of the mmg distribution only if you accept them. + ** ============================================================================= + **/ /** * Example of use of the mmg3d library (migrate from the mmg3d4 to the mmg3d diff --git a/libexamples/mmg3d/adaptation_example2/main.c b/libexamples/mmg3d/adaptation_example2/main.c index db135c77a..e0df1d48c 100644 --- a/libexamples/mmg3d/adaptation_example2/main.c +++ b/libexamples/mmg3d/adaptation_example2/main.c @@ -1,4 +1,4 @@ -/* ============================================================================= +/** ============================================================================= ** This file is part of the mmg software package for the tetrahedral ** mesh modification. ** Copyright (c) Bx INP/Inria/UBordeaux/UPMC, 2004- . @@ -19,7 +19,7 @@ ** . Please read their terms carefully and ** use this copy of the mmg distribution only if you accept them. ** ============================================================================= -*/ +**/ /** * Example of use of the mmg3d library (advanced use of mesh adaptation) diff --git a/src/mmg3d/libmmg3d.h b/src/mmg3d/libmmg3d.h index c0f6b1b96..8e98183f9 100644 --- a/src/mmg3d/libmmg3d.h +++ b/src/mmg3d/libmmg3d.h @@ -33,15 +33,13 @@ * \warning Use the MMG3D_ prefix: the MMG5_ prefix will become obsolete. * * \htmlonly - * *

Examples

* \endhtmlonly * * A very simple example code for mesh adaptation with automatic parsing of .mesh files - * \include libexamples/mmg3d/adaptation_example0/example0_a/main.c + * \dontinclude libexamples/mmg3d/adaptation_example0/example0_a/main.c + * \skipline BEGIN_EXAMPLE + * \until END_EXAMPLE * * Mesh adaptation example in which get/set functions are used to provide input to * the library and to extract the output mesh. @@ -56,7 +54,7 @@ * Mesh adaptation example. * \include libexamples/mmg3d/adaptation_example1/main.c * - * Mesh adaptation example. + * Another mesh adaptation example. * \include libexamples/mmg3d/adaptation_example2/main.c * * Isosurface discretization example (with metric) From b5062c502f2aad77f537c40e31b125093f7dac0d Mon Sep 17 00:00:00 2001 From: Mark Potse Date: Sun, 3 Mar 2024 12:32:09 +0100 Subject: [PATCH 06/11] explained the unused metric field in the Lagrangian-motion example --- .../IsosurfDiscretization_lsAndMetric/main.c | 2 +- .../mmg3d/LagrangianMotion_example0/main.c | 45 +++++++++++-------- 2 files changed, 27 insertions(+), 20 deletions(-) diff --git a/libexamples/mmg3d/IsosurfDiscretization_lsAndMetric/main.c b/libexamples/mmg3d/IsosurfDiscretization_lsAndMetric/main.c index fe62f9ead..a4b745404 100644 --- a/libexamples/mmg3d/IsosurfDiscretization_lsAndMetric/main.c +++ b/libexamples/mmg3d/IsosurfDiscretization_lsAndMetric/main.c @@ -135,7 +135,7 @@ int main(int argc,char *argv[]) { /** b) give metric values and positions */ for(k=1 ; k<=np ; k++) { - /* the Metric is constant over the mesh and follow the canonical + /* the Metric is constant over the mesh and follows the canonical * directions: it is given by the tensor (10000,0,100) */ if ( MMG3D_Set_tensorSol(mmgMet,10,0,0,1,0,1,k) != 1 ) exit(EXIT_FAILURE); } diff --git a/libexamples/mmg3d/LagrangianMotion_example0/main.c b/libexamples/mmg3d/LagrangianMotion_example0/main.c index 9404efeea..cc73b83f1 100644 --- a/libexamples/mmg3d/LagrangianMotion_example0/main.c +++ b/libexamples/mmg3d/LagrangianMotion_example0/main.c @@ -50,14 +50,14 @@ int main(int argc,char *argv[]) { MMG5_pMesh mmgMesh; - MMG5_pSol mmgSol,mmgDisp; + MMG5_pSol mmgMetric, mmgDisp; int ier; - char *inname,*outname; + char *inname, *outname; - fprintf(stdout," -- TEST MMG3DMOV \n"); + fprintf(stdout, " -- TEST MMG3DMOV \n"); if ( argc != 3 ) { - printf(" Usage: %s filein fileout \n",argv[0]); + printf(" Usage: %s filein fileout \n", argv[0]); return(1); } @@ -78,17 +78,23 @@ int main(int argc,char *argv[]) { /** 1) Initialisation of mesh and sol structures */ /* args of InitMesh: - * MMG5_ARG_start: we start to give the args of a variadic func + * MMG5_ARG_start: we start to give the args of a variadic function * MMG5_ARG_ppMesh: next arg will be a pointer to an MMG5_pMesh * &mmgMesh: pointer to your MMG5_pMesh (that stores your mesh) - * MMG5_ARG_ppMet: next arg will be a pointer to an MMG5_pSol storing a metric - * &mmgSol: pointer to your MMG5_pSol (that stores your metric) */ + * MMG5_ARG_ppMet: next arg will be a pointer to MMG5_pSol storing a metric + * &mmgMetric: pointer to an MMG5_pSol that stores your metric field + * MMG5_ARG_ppDisp: next arg will be a pointer to MMG5_pSol storing a displacement + * &mmgDisp: pointer to an MMG5_pSol that stores your displacement field + * In this example the metric field is not used but it must be provided + * to MMG3D_mmg3dmov() and therefore it must be initialized; it cannot + * remain a NULL pointer. */ mmgMesh = NULL; - mmgSol = NULL; + mmgMetric = NULL; mmgDisp = NULL; MMG3D_Init_mesh(MMG5_ARG_start, - MMG5_ARG_ppMesh,&mmgMesh,MMG5_ARG_ppMet,&mmgSol, - MMG5_ARG_ppDisp,&mmgDisp, + MMG5_ARG_ppMesh, &mmgMesh, + MMG5_ARG_ppMet, &mmgMetric, + MMG5_ARG_ppDisp, &mmgDisp, MMG5_ARG_end); /** 2) Build mesh in MMG5 format */ @@ -96,7 +102,7 @@ int main(int argc,char *argv[]) { file formatted or manually set your mesh using the MMG3D_Set* functions */ /** with MMG3D_loadMesh function */ - if ( MMG3D_loadMesh(mmgMesh,inname) != 1 ) exit(EXIT_FAILURE); + if ( MMG3D_loadMesh(mmgMesh, inname) != 1 ) exit(EXIT_FAILURE); /** 3) Build displacement in MMG5 format */ /** Two solutions: just use the MMG3D_loadSol function that will read a .sol(b) @@ -104,15 +110,15 @@ int main(int argc,char *argv[]) { /**------------------- Lagrangian motion option ----------------------------*/ /* Ask for lagrangian motion (mode 1) */ - if ( MMG3D_Set_iparameter(mmgMesh,mmgDisp,MMG3D_IPARAM_lag, 1) != 1 ) + if ( MMG3D_Set_iparameter(mmgMesh, mmgDisp, MMG3D_IPARAM_lag, 1) != 1 ) exit(EXIT_FAILURE); /** With MMG3D_loadSol function */ - if ( MMG3D_loadSol(mmgMesh,mmgDisp,inname) != 1 ) + if ( MMG3D_loadSol(mmgMesh, mmgDisp, inname) != 1 ) exit(EXIT_FAILURE); /** 4) (not mandatory): check if the number of given entities match with mesh size */ - if ( MMG3D_Chk_meshData(mmgMesh,mmgDisp) != 1 ) exit(EXIT_FAILURE); + if ( MMG3D_Chk_meshData(mmgMesh, mmgDisp) != 1 ) exit(EXIT_FAILURE); /** 5) (not mandatory): set your global parameters using the MMG3D_Set_iparameter and MMG3D_Set_dparameter function @@ -122,11 +128,11 @@ int main(int argc,char *argv[]) { /**------------------- Lagrangian motion computation ---------------------*/ /* debug mode ON (default value = OFF) */ - if ( MMG3D_Set_iparameter(mmgMesh,mmgDisp,MMG3D_IPARAM_debug, 1) != 1 ) + if ( MMG3D_Set_iparameter(mmgMesh, mmgDisp, MMG3D_IPARAM_debug, 1) != 1 ) exit(EXIT_FAILURE); /** remesh function */ - ier = MMG3D_mmg3dmov(mmgMesh,mmgSol,mmgDisp); + ier = MMG3D_mmg3dmov(mmgMesh, mmgMetric, mmgDisp); if ( ier == MMG5_STRONGFAILURE ) { fprintf(stdout,"BAD ENDING OF MMG3DMOV: UNABLE TO SAVE MESH\n"); @@ -135,13 +141,14 @@ int main(int argc,char *argv[]) { fprintf(stdout,"BAD ENDING OF MMG3DMOV\n"); /* (Not mandatory) Automatically save the mesh */ - if ( MMG3D_saveMesh(mmgMesh,outname) != 1 ) + if ( MMG3D_saveMesh(mmgMesh, outname) != 1 ) exit(EXIT_FAILURE); /* 9) free the MMG3D5 structures */ MMG3D_Free_all(MMG5_ARG_start, - MMG5_ARG_ppMesh,&mmgMesh,MMG5_ARG_ppMet,&mmgSol, - MMG5_ARG_ppDisp,&mmgDisp, + MMG5_ARG_ppMesh, &mmgMesh, + MMG5_ARG_ppMet, &mmgMetric, + MMG5_ARG_ppDisp, &mmgDisp, MMG5_ARG_end); free(inname); inname = NULL; From 10bfe3f714e22b8e5f34dfbe2ae15b1aa19a5250 Mon Sep 17 00:00:00 2001 From: Mark Potse Date: Sun, 3 Mar 2024 13:20:41 +0100 Subject: [PATCH 07/11] use a custom css file to limit text width in paragraphs --- doc/doxygen/Doxyfile.in | 2 +- doc/doxygen/custom.css | 14 ++++++++++++++ 2 files changed, 15 insertions(+), 1 deletion(-) create mode 100644 doc/doxygen/custom.css diff --git a/doc/doxygen/Doxyfile.in b/doc/doxygen/Doxyfile.in index 18c8daa9c..0561f95bc 100644 --- a/doc/doxygen/Doxyfile.in +++ b/doc/doxygen/Doxyfile.in @@ -1033,7 +1033,7 @@ HTML_FOOTER = # see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_STYLESHEET = +HTML_EXTRA_STYLESHEET = @CMAKE_CURRENT_SOURCE_DIR@/doc/doxygen/custom.css # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note diff --git a/doc/doxygen/custom.css b/doc/doxygen/custom.css new file mode 100644 index 000000000..9fba977e2 --- /dev/null +++ b/doc/doxygen/custom.css @@ -0,0 +1,14 @@ +/* -*- mode:css; css-indent-offset:2 -*- + * Style customizations for the Doxygen documentation of Mmgtools + * initial version by Mark Potse 03/2024 + */ + + +div.contents { + +} + +p { + max-width: 800px; /* limit text line width, for readability */ +} + From b13152e5876c828defb9dae565eb5ea7d22b4c4e Mon Sep 17 00:00:00 2001 From: Mark Potse Date: Sun, 3 Mar 2024 14:37:54 +0100 Subject: [PATCH 08/11] added a lot of \brief tags and fixed language problems --- src/mmg3d/libmmg3d.h | 369 +++++++++++++++++++++++++++++-------------- 1 file changed, 248 insertions(+), 121 deletions(-) diff --git a/src/mmg3d/libmmg3d.h b/src/mmg3d/libmmg3d.h index 8e98183f9..6446efd81 100644 --- a/src/mmg3d/libmmg3d.h +++ b/src/mmg3d/libmmg3d.h @@ -95,36 +95,36 @@ enum MMG3D_Param { MMG3D_IPARAM_angle, /*!< [1/0], Turn on/off angle detection */ MMG3D_IPARAM_iso, /*!< [1/0], Level-set meshing */ MMG3D_IPARAM_isosurf, /*!< [1/0], Level-set meshing on the surface part */ - MMG3D_IPARAM_nofem, /*!< [1/0], Generate a non finite element mesh */ + MMG3D_IPARAM_nofem, /*!< [1/0], Do not attempt to make the mesh suitable for finite-element computations */ MMG3D_IPARAM_opnbdy, /*!< [1/0], Preserve triangles at interface of 2 domains with same reference */ MMG3D_IPARAM_lag, /*!< [-1/0/1/2], Lagrangian option */ MMG3D_IPARAM_optim, /*!< [1/0], Optimize mesh keeping its initial edge sizes */ - MMG3D_IPARAM_optimLES, /*!< [1/0], Strong mesh optimization for Les computations */ + MMG3D_IPARAM_optimLES, /*!< [1/0], Strong mesh optimization for LES computations */ MMG3D_IPARAM_noinsert, /*!< [1/0], Avoid/allow point insertion */ MMG3D_IPARAM_noswap, /*!< [1/0], Avoid/allow edge or face flipping */ MMG3D_IPARAM_nomove, /*!< [1/0], Avoid/allow point relocation */ MMG3D_IPARAM_nosurf, /*!< [1/0], Avoid/allow surface modifications */ - MMG3D_IPARAM_nreg, /*!< [0/1], Enable normal regularization */ - MMG3D_IPARAM_xreg, /*!< [0/1], Enable coordinates regularization */ + MMG3D_IPARAM_nreg, /*!< [0/1], Enable regularization of normals */ + MMG3D_IPARAM_xreg, /*!< [0/1], Enable boundary regularization by moving vertices */ MMG3D_IPARAM_numberOfLocalParam, /*!< [n], Number of local parameters */ MMG3D_IPARAM_numberOfLSBaseReferences, /*!< [n], Number of base references for bubble removal */ - MMG3D_IPARAM_numberOfMat, /*!< [n], Number of material in ls mode */ - MMG3D_IPARAM_numsubdomain, /*!< [0/n], Save the subdomain nb (0==all subdomain) */ + MMG3D_IPARAM_numberOfMat, /*!< [n], Number of materials in level-set mode */ + MMG3D_IPARAM_numsubdomain, /*!< [0/n], Save the subdomain nb (0==all subdomains) */ MMG3D_IPARAM_renum, /*!< [1/0], Turn on/off point relocation with Scotch */ MMG3D_IPARAM_anisosize, /*!< [1/0], Turn on/off anisotropic metric creation when no metric is provided */ MMG3D_IPARAM_octree, /*!< [n], Specify the max number of points per PROctree cell (DELAUNAY) */ - MMG3D_IPARAM_nosizreq, /*!< [0/1], Allow/avoid overwritten of sizes at required points (advanced usage) */ + MMG3D_IPARAM_nosizreq, /*!< [0/1], Allow/avoid overwriting of sizes at required points (advanced usage) */ MMG3D_IPARAM_isoref, /*!< [0/n], Isosurface boundary material reference */ - MMG3D_DPARAM_angleDetection, /*!< [val], Value for angle detection */ - MMG3D_DPARAM_hmin, /*!< [val], Minimal mesh size */ - MMG3D_DPARAM_hmax, /*!< [val], Maximal mesh size */ - MMG3D_DPARAM_hsiz, /*!< [val], Constant mesh size */ + MMG3D_DPARAM_angleDetection, /*!< [val], Value for angle detection (degrees) */ + MMG3D_DPARAM_hmin, /*!< [val], Minimal edge length */ + MMG3D_DPARAM_hmax, /*!< [val], Maximal edge length */ + MMG3D_DPARAM_hsiz, /*!< [val], Constant edge length */ MMG3D_DPARAM_hausd, /*!< [val], Control global Hausdorff distance (on all the boundary surfaces of the mesh) */ MMG3D_DPARAM_hgrad, /*!< [val], Control gradation */ MMG3D_DPARAM_hgradreq, /*!< [val], Control gradation on required entites (advanced usage) */ - MMG3D_DPARAM_ls, /*!< [val], Value of level-set */ - MMG3D_DPARAM_xreg, /*!< [val], Value of relaxation parameter for coordinates regularization (0 SUBROUTINE MMG3D_INIT_FILENAMES(mesh,sol)\n @@ -179,7 +186,10 @@ enum MMG3D_Param { * */ LIBMMG3D_EXPORT void MMG3D_Init_fileNames(MMG5_pMesh mesh, MMG5_pSol sol); + /** + * \brief Initialize parameters to their default values + * * \param mesh pointer to the mesh structure. * * Initialization of the input parameters (stored in the Info structure). @@ -198,7 +208,7 @@ enum MMG3D_Param { * \param meshin input mesh name. * \return 1. * - * Set the name of input mesh. + * \brief Set the name of input mesh. * * \remark Fortran interface: * > SUBROUTINE MMG3D_SET_INPUTMESHNAME(mesh,meshin,strlen0,retval)\n @@ -210,12 +220,13 @@ enum MMG3D_Param { * */ LIBMMG3D_EXPORT int MMG3D_Set_inputMeshName(MMG5_pMesh mesh,const char* meshin); + /** * \param mesh pointer to the mesh structure. * \param meshout name of the output mesh file. * \return 1. * - * Set the name of output mesh file. + * \brief Set the name of output mesh file. * * \remark Fortran interface: * > SUBROUTINE MMG3D_SET_OUTPUTMESHNAME(mesh,meshout,strlen0,retval)\n @@ -227,13 +238,14 @@ enum MMG3D_Param { * */ LIBMMG3D_EXPORT int MMG3D_Set_outputMeshName(MMG5_pMesh mesh, const char* meshout); + /** * \param mesh pointer to the mesh structure. * \param sol pointer to the sol structure. * \param solin name of the input solution file. * \return 1. * - * Set the name of input solution file. + * \brief Set the name of input solution file. * * \remark Fortran interface: * > SUBROUTINE MMG3D_SET_INPUTSOLNAME(mesh,sol,solin,strlen0,retval)\n @@ -246,13 +258,14 @@ enum MMG3D_Param { */ LIBMMG3D_EXPORT int MMG3D_Set_inputSolName(MMG5_pMesh mesh,MMG5_pSol sol, const char* solin); + /** * \param mesh pointer to the mesh structure. * \param sol pointer to the sol structure. * \param solout name of the output solution file. * \return 0 if failed, 1 otherwise. * - * Set the name of output solution file. + * \brief Set the name of the output solution file. * * \remark Fortran interface: * > SUBROUTINE MMG3D_SET_OUTPUTSOLNAME(mesh,sol,solout,strlen0,retval)\n @@ -265,12 +278,13 @@ enum MMG3D_Param { */ LIBMMG3D_EXPORT int MMG3D_Set_outputSolName(MMG5_pMesh mesh,MMG5_pSol sol, const char* solout); + /** * \param mesh pointer to the mesh structure. * \param fparamin name of the input parameter file. * \return 1. * - * Set the name of input parameter file. + * \brief Set the name of the input parameter file. * * \remark Fortran interface: * > SUBROUTINE MMG3D_SET_INPUTPARAMNAME(mesh,fparamin,strlen0,retval)\n @@ -286,6 +300,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara /* init structure sizes */ /** + * \brief Initialize a solution field. * \param mesh pointer to the mesh structure. * \param sol pointer to the sol structure. * \param typEntity type of solutions entities (vertices, triangles...). @@ -309,6 +324,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara MMG5_int np, int typSol); /** + * \brief Initialize an array of solution values defined at vertices * \param mesh pointer to the mesh structure. * \param sol pointer to an allocatable sol structure. * \param nsols number of solutions per entity @@ -317,9 +333,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara * (scalar, vectorial...). * \return 0 if failed, 1 otherwise. * - * Initialize an array of solutions field defined at vertices: set dimension, - * types and number of data. - * To use to initialize an array of solution fields (not used by Mmg itself). + * Initialize a solution field defined at vertices: set dimension, + * types and number of data values. (not used by Mmg itself). * * \remark Fortran interface: * > SUBROUTINE MMG3D_SET_SOLSATVERTICESSIZE(mesh,sol,nsols,nentities,typSol,retval)\n @@ -335,6 +350,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara MMG5_int nentities, int *typSol); /** + * \brief Set the number of vertices, tetrahedra, prisms, triangles, quadrilaterals, + * and edges of a mesh. * \param mesh pointer to the mesh structure. * \param np number of vertices. * \param ne number of tetrahedra. @@ -344,9 +361,9 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara * \param na number of edges. * \return 0 if failed, 1 otherwise. * - * Set the number of vertices, tetrahedra, prisms, triangles, quadrilaterals and - * edges of the mesh and allocate the associated tables. If call twice, reset - * the whole mesh to realloc it at the new size + * This function sets the number of vertices, tetrahedra, prisms, triangles, + * quadrilaterals and edges of the mesh and allocates the associated arrays. If + * called again, it will reset the whole mesh to reallocate it at the new size * * \remark Fortran interface: * > SUBROUTINE MMG3D_SET_MESHSIZE(mesh,np,ne,nprism,nt,nquad,na,retval)\n @@ -359,8 +376,9 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Set_meshSize(MMG5_pMesh mesh,MMG5_int np,MMG5_int ne,MMG5_int nprism, MMG5_int nt,MMG5_int nquad,MMG5_int na); -/* init structure datas */ +/* init structure data */ /** + * \brief Set the coordinates of a single vertex. * \param mesh pointer to the mesh structure. * \param c0 coordinate of the point along the first dimension. * \param c1 coordinate of the point along the second dimension. @@ -369,7 +387,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara * \param pos position of the point in the mesh. * \return 1. * - * Set vertex of coordinates \a c0, \a c1,\a c2 and reference \a ref + * This function sets the coordinates of a vertex \a c0, \a c1,\a c2 and reference \a ref * at position \a pos in mesh structure (from 1 to nb_vertices included). * * \remark Fortran interface: @@ -383,8 +401,9 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara */ LIBMMG3D_EXPORT int MMG3D_Set_vertex(MMG5_pMesh mesh, double c0, double c1, double c2, MMG5_int ref,MMG5_int pos); + /** - * \brief Set vertex coordinates and references in a mesh structure + * \brief Set all vertex coordinates and references in a mesh structure * * \param mesh pointer to the mesh structure. * \param vertices array of vertex coordinates in the order \f$[x_1, y_1, z_1, x_2, \ldots, z_N]\f$ @@ -410,6 +429,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Set_vertices(MMG5_pMesh mesh, double *vertices,MMG5_int *refs); /** + * \brief set a single tetrahedron's vertices + * * \param mesh pointer to the mesh structure. * \param v0 first vertex of tetrahedron. * \param v1 second vertex of tetrahedron. @@ -419,8 +440,9 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara * \param pos tetrahedron position in the mesh. * \return 0 if failed, 1 otherwise. * - * Set tetrahedra of vertices \a v0, \a v1,\a v2,\a v3 and reference - * \a ref at position \a pos in mesh structure (from 1 to nb_tetra included). + * Assign the vertices \a v0, \a v1,\a v2,\a v3 and reference + * \a ref to the tetrahedron at position \a pos in the mesh structure. + * \a pos ranges from 1 to nb_tetra included. * * \remark Fortran interface: * > SUBROUTINE MMG3D_SET_TETRAHEDRON(mesh,v0,v1,v2,v3,ref,pos,retval)\n @@ -435,14 +457,17 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara MMG5_int v2, MMG5_int v3, MMG5_int ref, MMG5_int pos); /** + * \brief Set the vertices and references of all tetrahedra in a mesh structure + * * \param mesh pointer to the mesh structure. - * \param tetra vertices of the tetras of the mesh - * Vertices of the \f$i^{th}\f$ tetra are stored in tetra[(i-1)*4]\@4. - * \param refs table of the tetrahedra references. - * References of the \f$i^{th}\f$ tetra is stored in refs[i-1]. + * \param tetra vertices of the tetras of the mesh given. + * The vertices of the \f$i^{th}\f$ tetrahedron are given by + * tetra[(i-1)*4] to tetra[(i-1)*4+3] included. + * \param refs array of the tetrahedra references. + * The references of the \f$i^{th}\f$ tetrahedron is given by refs[i-1]. * \return 0 if failed, 1 otherwise. * - * Set vertices and references of the mesh tetrahedra. + * This function sets the vertices and references of all tetrahedra in a mesh. * * \remark Fortran interface: (commentated in * order to allow to pass \%val(0) instead of the refs array) @@ -457,7 +482,10 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara */ LIBMMG3D_EXPORT int MMG3D_Set_tetrahedra(MMG5_pMesh mesh, MMG5_int *tetra, MMG5_int *refs); + /** + * \brief Set the vertices and reference of a single prism in a mesh. + * * \param mesh pointer to the mesh structure. * \param v0 first vertex of prism. * \param v1 second vertex of prism. @@ -469,8 +497,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara * \param pos prism position in the mesh. * \return 0 if failed, 1 otherwise. * - * Set prisms of vertices \a v0, \a v1,\a v2,\a v3,\a v4,\a v5 and reference - * \a ref at position \a pos in mesh structure (from 1 to nb_prisms included). + * This function sets the six vertices \a v0, \a v1,\a v2,\a v3,\a v4,\a v5 and reference + * \a ref for the prism at position \a pos in the mesh structure (from 1 to nb_prisms included). * * \remark Fortran interface: * > SUBROUTINE MMG3D_SET_PRISM(mesh,v0,v1,v2,v3,v4,v5,ref,pos,retval)\n @@ -482,15 +510,19 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara */ LIBMMG3D_EXPORT int MMG3D_Set_prism(MMG5_pMesh mesh, MMG5_int v0, MMG5_int v1, MMG5_int v2, MMG5_int v3, MMG5_int v4, MMG5_int v5, MMG5_int ref, MMG5_int pos); + /** + * \brief Set the vertices and references of all prisms in a mesh. + * * \param mesh pointer to the mesh structure. * \param prisms vertices of the prisms of the mesh - * Vertices of the \f$i^{th}\f$ prism are stored in prism[(i-1)*6]\@6. - * \param refs table of the prisms references. - * References of the \f$i^{th}\f$ prisms is stored in refs[i-1]. + * Vertices of the \f$i^{th}\f$ prism are stored in prism[(i-1)*6] + * to prism[(i-1)*6+5] included. + * \param refs array of the prisms references. + * The references of the \f$i^{th}\f$ prism is stored in refs[i-1]. * \return 0 if failed, 1 otherwise. * - * Set vertices and references of the mesh prisms. + * This function sets the vertices and references of all prisms in a mesh. * * \remark Fortran interface: (commentated in * order to allow to pass \%val(0) instead of the refs array) @@ -507,6 +539,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara MMG5_int *refs); /** + * \brief Set the vertices and reference of a single triangle in a mesh. + * * \param mesh pointer to the mesh structure. * \param v0 first vertex of triangle. * \param v1 second vertex of triangle. @@ -515,7 +549,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara * \param pos triangle position in the mesh. * \return 0 if failed, 1 otherwise. * - * Set triangle of vertices \a v0, \a v1, \a v2 and reference \a ref + * This function defines a triangle of vertices \a v0, \a v1, \a v2 and reference \a ref * at position \a pos in mesh structure (from 1 to nb_triangle included). * * \remark Fortran interface: @@ -528,15 +562,18 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara */ LIBMMG3D_EXPORT int MMG3D_Set_triangle(MMG5_pMesh mesh, MMG5_int v0, MMG5_int v1, MMG5_int v2, MMG5_int ref,MMG5_int pos); + /** + * \brief Set the vertices and references of all triangles ni a mesh. + * * \param mesh pointer to the mesh structure. - * \param tria pointer to the table of the tria vertices + * \param tria pointer to the array of the tria vertices * Vertices of the \f$i^{th}\f$ tria are stored in tria[(i-1)*3]\@3. - * \param refs pointer to the table of the triangle references. + * \param refs pointer to the array of the triangle references. * refs[i-1] is the ref of the \f$i^{th}\f$ tria. * \return 0 if failed, 1 otherwise. * - * Set vertices and references of the mesh triangles. + * This function sets the vertices and references of all triangles in a mesh. * * \remark Fortran interface: (commentated in * order to allow to pass \%val(0) instead of the refs array) @@ -550,7 +587,10 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara * */ LIBMMG3D_EXPORT int MMG3D_Set_triangles(MMG5_pMesh mesh, MMG5_int *tria, MMG5_int *refs); + /** + * \brief Set the vertices and reference of a single quadrilateral in a mesh. + * * \param mesh pointer to the mesh structure. * \param v0 first vertex of quadrilateral. * \param v1 second vertex of quadrilateral. @@ -560,7 +600,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara * \param pos quadrilateral position in the mesh. * \return 0 if failed, 1 otherwise. * - * Set quadrilateral of vertices \a v0, \a v1, \a v2, \a v3 and reference \a ref + * Set a quadrilateral of vertices \a v0, \a v1, \a v2, \a v3 and reference \a ref * at position \a pos in mesh structure (from 1 to nb_quadrangles included). * * \remark Fortran interface: @@ -573,11 +613,14 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara */ LIBMMG3D_EXPORT int MMG3D_Set_quadrilateral(MMG5_pMesh mesh, MMG5_int v0, MMG5_int v1, MMG5_int v2, MMG5_int v3, MMG5_int ref,MMG5_int pos); + /** + * \brief Set the vertices and references of all quadrilaterals in a mesh. + * * \param mesh pointer to the mesh structure. - * \param quads pointer to the table of the quads vertices + * \param quads pointer to the array of the quads vertices * Vertices of the \f$i^{th}\f$ quadra are stored in quads[(i-1)*3]\@3. - * \param refs pointer to the table of the quadrilateral references. + * \param refs pointer to the array of the quadrilateral references. * refs[i-1] is the ref of the \f$i^{th}\f$ quadra. * \return 0 if failed, 1 otherwise. * @@ -595,7 +638,10 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara * */ LIBMMG3D_EXPORT int MMG3D_Set_quadrilaterals(MMG5_pMesh mesh, MMG5_int *quads, MMG5_int *refs); + /** + * \brief Set the vertices and reference of a single edge in a mesh. + * * \param mesh pointer to the mesh structure. * \param v0 first extremity of the edge. * \param v1 second extremity of the edge. @@ -615,12 +661,16 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara * */ LIBMMG3D_EXPORT int MMG3D_Set_edge(MMG5_pMesh mesh, MMG5_int v0, MMG5_int v1, MMG5_int ref,MMG5_int pos); + /** + * \brief Assign the "corner" attribute to a vertex. + * * \param mesh pointer to the mesh structure. * \param k vertex index. * \return 1. * - * Set corner at point \a pos. + * Set the "corner" attribute at point \a pos. This affects how the vertex is + * treated during remeshing. * * \remark Fortran interface: * > SUBROUTINE MMG3D_SET_CORNER(mesh,k,retval)\n @@ -633,6 +683,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Set_corner(MMG5_pMesh mesh, MMG5_int k); /** + * \brief Remove the "corner" attribute from a vertex. + * * \param mesh pointer to the mesh structure. * \param k vertex index. * \return 1. @@ -651,11 +703,14 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Unset_corner(MMG5_pMesh mesh, MMG5_int k); /** + * \brief Assign the "required" attribute to a vertex. + * * \param mesh pointer to the mesh structure. * \param k vertex index. * \return 1. * - * Set point \a k as required (\a k from 1 to nb_vertices included). + * Set vertex \a k as required (\a k from 1 to nb_vertices included). This + * prevents the remesher from moving the vertex. * * \remark Fortran interface: * > SUBROUTINE MMG3D_SET_REQUIREDVERTEX(mesh,k,retval)\n @@ -668,11 +723,13 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Set_requiredVertex(MMG5_pMesh mesh, MMG5_int k); /** + * \brief Remove required attribute from a vertex. + * * \param mesh pointer to the mesh structure. * \param k vertex index. * \return 1. * - * Remove required attribute from point \a k. + * This function removes the required attribute from point \a k. * * \remark Fortran interface: * > SUBROUTINE MMG3D_UNSET_REQUIREDVERTEX(mesh,k,retval)\n @@ -685,6 +742,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Unset_requiredVertex(MMG5_pMesh mesh, MMG5_int k); /** + * \brief Assign the "required" attribute to a tetrahedron. + * * \param mesh pointer to the mesh structure. * \param k element index. * \return 1. @@ -702,6 +761,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Set_requiredTetrahedron(MMG5_pMesh mesh, MMG5_int k); /** + * \brief Remove the "required" attribute from a tetrahedron. + * * \param mesh pointer to the mesh structure. * \param k element index. * \return 1. @@ -720,12 +781,14 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Unset_requiredTetrahedron(MMG5_pMesh mesh, MMG5_int k); /** + * \brief Assign the "required" attribute to multiple tetrahedra. + * * \param mesh pointer to the mesh structure. - * \param reqIdx table of the indices of the required elements. + * \param reqIdx array of the indices of the required elements. * \param nreq number of required elements * \return 1. * - * Set the required Tetra. + * Determine which tetrahedra have the "required" attribute. * * \remark Fortran interface: * > SUBROUTINE MMG3D_SET_REQUIREDTETRAHEDRA(mesh,reqIdx,nreq,retval)\n @@ -739,8 +802,10 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Set_requiredTetrahedra(MMG5_pMesh mesh, MMG5_int *reqIdx, MMG5_int nreq); /** + * \brief Remove the "required" attribute from multiple tetrahedra. + * * \param mesh pointer to the mesh structure. - * \param reqIdx table of the indices of the required elements. + * \param reqIdx array of the indices of the required elements. * \param nreq number of required elements * \return 1. * @@ -759,6 +824,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Unset_requiredTetrahedra(MMG5_pMesh mesh, MMG5_int *reqIdx, MMG5_int nreq); /** + * \brief Assign the "required" attribute to a single triangle. + * * \param mesh pointer to the mesh structure. * \param k triangle index. * \return 1. @@ -776,6 +843,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Set_requiredTriangle(MMG5_pMesh mesh, MMG5_int k); /** + * \brief Remove the "required" attribute from a single triangle. + * * \param mesh pointer to the mesh structure. * \param k triangle index. * \return 1. @@ -793,13 +862,13 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Unset_requiredTriangle(MMG5_pMesh mesh, MMG5_int k); /** + * \brief Assign the "required" attribute to multiple triangles. + * * \param mesh pointer to the mesh structure. - * \param reqIdx table of the indices of the required trias. - * \param nreq number of required trias + * \param reqIdx array of the indices of the required triangles. + * \param nreq number of required triangles * \return 1. * - * Set the required triangles - * * \remark Fortran interface: * > SUBROUTINE MMG3D_SET_REQUIREDTRIANGLES(mesh,reqIdx,nreq,retval)\n * > MMG5_DATA_PTR_T,INTENT(INOUT) :: mesh\n @@ -812,13 +881,13 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Set_requiredTriangles(MMG5_pMesh mesh, MMG5_int *reqIdx, MMG5_int nreq); /** + * \brief Remove the "required" attribute from multiple triangles. + * * \param mesh pointer to the mesh structure. - * \param reqIdx table of the indices of the required trias. + * \param reqIdx array of the indices of the required trias. * \param nreq number of required trias * \return 1. * - * Remove required attribute from triangles - * * \remark Fortran interface: * > SUBROUTINE MMG3D_UNSET_REQUIREDTRIANGLES(mesh,reqIdx,nreq,retval)\n * > MMG5_DATA_PTR_T,INTENT(INOUT) :: mesh\n @@ -831,6 +900,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Unset_requiredTriangles(MMG5_pMesh mesh, MMG5_int *reqIdx, MMG5_int nreq); /** + * \brief Assign the "parallel" attribute to a single triangle. + * * \param mesh pointer to the mesh structure. * \param k triangle index. * \return 1. @@ -849,11 +920,13 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Set_parallelTriangle(MMG5_pMesh mesh, MMG5_int k); /** + * \brief Remove the "parallel" attribute from a single triangle. + * * \param mesh pointer to the mesh structure. * \param k triangle index. * \return 1. * - * Remove parallel attribute from triangle \a k (ie tria aren't preserved + * Remove parallel attribute from triangle \a k (i.e. triangles aren't preserved * anymore). (\a k from 1 to nb_tria included). * * \remark Fortran interface: @@ -867,13 +940,15 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Unset_parallelTriangle(MMG5_pMesh mesh, MMG5_int k); /** - * \param mesh pointer to the mesh structure. - * \param parIdx table of the indices of the parallel trias. - * \param npar number of triangles between processors. + * \brief Assign the "parallel" attribute to multiple triangles. + * + * \param mesh pointer to the mesh structure + * \param parIdx array of indices of triangles + * \param npar number of triangles * \return 1. * - * Set the parallel triangles (triangles at the interface between processors, ie - * this triangles are required). + * Set the parallel triangles (triangles at the interface between processors, i.e. + * these triangles are required). * * \remark Fortran interface: * > SUBROUTINE MMG3D_SET_PARALLELTRIANGLES(mesh,parIdx,npar,retval)\n @@ -887,13 +962,15 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Set_parallelTriangles(MMG5_pMesh mesh, MMG5_int *parIdx, MMG5_int npar); /** + * \brief Remove the "parallel" attribute from multiple triangles. + * * \param mesh pointer to the mesh structure. - * \param parIdx table of the indices of the parallel trias. - * \param npar number of triangles between processors. + * \param parIdx array of the indices of triangles + * \param npar number of triangles * \return 1. * - * Remove parallel attributes from triangles (ie - * tria aren't preserved anymore). + * Remove parallel attributes from triangles (i.e. + * triangles aren't preserved anymore). * * \remark Fortran interface: * > SUBROUTINE MMG3D_UNSET_PARALLELTRIANGLES(mesh,parIdx,npar,retval)\n @@ -907,11 +984,14 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Unset_parallelTriangles(MMG5_pMesh mesh, MMG5_int *parIdx, MMG5_int npar); /** + * \brief Assign the "ridge" attribute to a single edge. + * * \param mesh pointer to the mesh structure. * \param k edge index. * \return 1. * - * Set ridge at edge \a k. + * Set the "ridge" attribute at edge \a k. This affects how the remesher treats + * the edge and the adjacent triangles or tetrahedra. * * \remark Fortran interface: * > SUBROUTINE MMG3D_SET_RIDGE(mesh,k,retval)\n @@ -924,6 +1004,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Set_ridge(MMG5_pMesh mesh, MMG5_int k); /** + * \brief Remove the "ridge" attribute from a single edge. + * * \param mesh pointer to the mesh structure. * \param k edge index. * \return 1. @@ -941,6 +1023,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Unset_ridge(MMG5_pMesh mesh, MMG5_int k); /** + * \brief Assign the "required" attribute to a single edge. + * * \param mesh pointer to the mesh structure. * \param k edge index. * \return 1. @@ -958,6 +1042,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Set_requiredEdge(MMG5_pMesh mesh, MMG5_int k); /** + * \brief Remove the "required" attribute from a single edge. + * * \param mesh pointer to the mesh structure. * \param k edge index. * \return 1. @@ -975,6 +1061,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Unset_requiredEdge(MMG5_pMesh mesh, MMG5_int k); /** + * \brief Set the normal orientation at a single vertex. + * * \param mesh pointer to the mesh structure. * \param k point index * \param n0 x componant of the normal at point \a k. @@ -983,7 +1071,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara * * \return 1 if success. * - * Set normals (n0,n1,n2) at point \a k. + * Set normal (n0,n1,n2) at vertex \a k. * * \remark Fortran interface: * > SUBROUTINE MMG3D_SET_NORMALATVERTEX(mesh,k,n0,n1,n2,retval)\n @@ -998,6 +1086,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara double n2) ; /** + * \brief Set a single element of a scalar solution structure. + * * \param met pointer to the sol structure. * \param s solution scalar value. * \param pos position of the solution in the mesh. @@ -1016,10 +1106,13 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara * */ LIBMMG3D_EXPORT int MMG3D_Set_scalarSol(MMG5_pSol met, double s,MMG5_int pos); + /** + * \brief Set the values of all elements of a scalar solution structure. + * * \param met pointer to the sol structure. - * \param s table of the scalar solutions values. - * s[i-1] is the solution at vertex i. + * \param s array of the scalar solutions values. + * s[i-1] is the solution at vertex i. * \return 0 if failed, 1 otherwise. * * Set scalar solutions at mesh vertices. @@ -1033,7 +1126,10 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara * */ LIBMMG3D_EXPORT int MMG3D_Set_scalarSols(MMG5_pSol met, double *s); + /** + * \brief Set a single element of a vector solution structure. + * * \param met pointer to the sol structure. * \param vx x value of the vectorial solution. * \param vy y value of the vectorial solution. @@ -1055,9 +1151,12 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara */ LIBMMG3D_EXPORT int MMG3D_Set_vectorSol(MMG5_pSol met, double vx,double vy, double vz, MMG5_int pos); + /** + * \brief Set all elements of a vector solution structure. + * * \param met pointer to the sol structure. - * \param sols table of the vectorial solutions + * \param sols array of the vectorial solutions * sols[3*(i-1)]\@3 is the solution at vertex i * \return 0 if failed, 1 otherwise. * @@ -1072,7 +1171,10 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara * */ LIBMMG3D_EXPORT int MMG3D_Set_vectorSols(MMG5_pSol met, double *sols); + /** + * \brief Set a single element of a tensor solution structure. + * * \param met pointer to the sol structure. * \param m11 value of the tensorial solution at position (1,1) in the tensor * \param m12 value of the tensorial solution at position (1,2) in the tensor @@ -1097,9 +1199,12 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara */ LIBMMG3D_EXPORT int MMG3D_Set_tensorSol(MMG5_pSol met, double m11,double m12, double m13, double m22,double m23, double m33, MMG5_int pos); + /** + * \brief Set all elements of a tensor solution structure. + * * \param met pointer to the sol structure. - * \param sols table of the tensorial solutions. + * \param sols array of the tensorial solutions. * sols[6*(i-1)]\@6 is the solution at vertex i * \return 0 if failed, 1 otherwise. * @@ -1114,7 +1219,10 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara * */ LIBMMG3D_EXPORT int MMG3D_Set_tensorSols(MMG5_pSol met, double *sols); + /** + * \brief Set a single element of one out of multiple solution fields that are defined on vertices. + * * \param sol pointer to the array of solutions * \param i position of the solution field that we want to set. * \param s solution(s) at mesh vertex \a pos. @@ -1137,16 +1245,19 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara * */ LIBMMG3D_EXPORT int MMG3D_Set_ithSol_inSolsAtVertices(MMG5_pSol sol,int i, double* s,MMG5_int pos); + /** + * \brief Set all elements of one out of multiple solution fields that are defined on vertices. + * * \param sol pointer to the array of solutions * \param i position of the solution field that we want to set. - * \param s table of the solutions at mesh vertices. The solution at vertex \a k + * \param s array of the solutions at mesh vertices. The solution at vertex \a k * is given by s[k-1] for a scalar sol, s[3*(k-1)]\@3 for a vectorial solution * and s[6*(k-1)]\@6 for a tensor solution. * * \return 0 if failed, 1 otherwise. * - * Get values of the ith field of the solution array by array (\a i from 1 to \a + * Set values of the ith field of the solution array by array (\a i from 1 to \a * nb_sols). * * \remark Fortran interface: @@ -1161,10 +1272,13 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Set_ithSols_inSolsAtVertices(MMG5_pSol sol,int i, double* s); /** + * \brief Finish providing mesh data without using the API functions. + * * \param mesh pointer to the mesh structure. * - * To mark as ended a mesh given without using the API functions - * (for example, mesh given by mesh->point[i] = 0 ...). Not recommanded. + * To mark as ended a mesh given without using the API functions (for example, + * mesh given by mesh->point[i] = 0 ...). This function performs veritications, + * e.g. to make sure that all tetrahedra are consistently oriented. * * \remark Fortran interface: * > SUBROUTINE MMG3D_SET_HANDGIVENMESH(mesh)\n @@ -1176,6 +1290,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara /* check init */ /** + * \brief Check if the number of given entities match with mesh and sol size + * * \param mesh pointer to the mesh structure. * \param met pointer to the sol structure. * \return 0 if failed, 1 otherwise. @@ -1194,6 +1310,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara /** functions to set parameters */ /** + * \brief set an integer parameter of the remesher + * * \param mesh pointer to the mesh structure. * \param sol pointer to the sol structure (unused). * \param iparam integer parameter to set (see \a MMG3D_Param structure). @@ -1214,7 +1332,10 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara */ LIBMMG3D_EXPORT int MMG3D_Set_iparameter(MMG5_pMesh mesh,MMG5_pSol sol, int iparam, MMG5_int val); + /** + * \brief set a real-valued parameter of the remesher + * * \param mesh pointer to the mesh structure. * \param sol pointer to the sol structure (unused). * \param dparam double parameter to set (see \a MMG3D_Param structure). @@ -1236,6 +1357,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Set_dparameter(MMG5_pMesh mesh,MMG5_pSol sol, int dparam, double val); /** + * \brief set a local parameter + * * \param mesh pointer to the mesh structure. * \param sol pointer to the sol structure. * \param typ type of entity (triangle, edge,...). @@ -1263,6 +1386,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara MMG5_int ref,double hmin,double hmax,double hausd); /** + * \brief Set the reference mapping for the elements of ref \a ref in ls discretization mode. + * * \param mesh pointer to the mesh structure. * \param sol pointer to the sol structure. * \param ref input tetra reference. @@ -1271,8 +1396,6 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara * \param rex external reference after ls discretization * \return 0 if failed, 1 otherwise. * - * Set the reference mapping for the elements of ref \a ref in ls discretization mode. - * * \remark Fortran interface: * > SUBROUTINE MMG3D_SET_MULTIMAT(mesh,sol,ref,split,rin,rex,retval)\n * > MMG5_DATA_PTR_T,INTENT(INOUT) :: mesh,sol\n @@ -1286,6 +1409,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara MMG5_int rin, MMG5_int rex); /** + * \brief Set a new level-set base reference. + * * \param mesh pointer to the mesh structure. * \param sol pointer to the sol structure. * \param br new level-set base reference. @@ -1437,15 +1562,15 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM /** * \param mesh pointer to the mesh structure. - * \param vertices pointer to the table of the points coordinates. + * \param vertices pointer to the array of the points coordinates. * The coordinates of the \f$i^{th}\f$ point are stored in * vertices[(i-1)*3]\@3. - * \param refs pointer to the table of the point references. + * \param refs pointer to the array of the point references. * The ref of the \f$i^th\f$ point is stored in refs[i-1]. - * \param areCorners pointer to the table of the flags saying if + * \param areCorners pointer to the array of the flags saying if * points are corners. * areCorners[i-1]=1 if the \f$i^{th}\f$ point is corner. - * \param areRequired pointer to the table of flags saying if points + * \param areRequired pointer to the array of flags saying if points * are required. areRequired[i-1]=1 if the \f$i^{th}\f$ point is required. * \return 1. * @@ -1495,11 +1620,11 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM MMG5_int* v3,MMG5_int* ref, int* isRequired); /** * \param mesh pointer to the mesh structure. - * \param tetra pointer to the table of the tetrahedra vertices. + * \param tetra pointer to the array of the tetrahedra vertices. * Vertices of the \f$i^{th}\f$ tetra are stored in tetra[(i-1)*4]\@4. - * \param refs pointer to the table of the tetrahedron references. + * \param refs pointer to the array of the tetrahedron references. * References of the \f$i^{th}\f$ tetra is stored in refs[i-1]. - * \param areRequired pointer to the table of the flags saying if the + * \param areRequired pointer to the array of the flags saying if the * tetrahedra are required. areRequired[i-1]=1 if the \f$i^{th}\f$ tetra * is required. * \return 0 if failed, 1 otherwise. @@ -1552,11 +1677,11 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM MMG5_int* v3,MMG5_int* v4,MMG5_int* v5,MMG5_int* ref, int* isRequired); /** * \param mesh pointer to the mesh structure. - * \param prisms pointer to the table of the prisms vertices. + * \param prisms pointer to the array of the prisms vertices. * Vertices of the \f$i^{th}\f$ prism are stored in prisms[(i-1)*6]\@6. - * \param refs pointer to the table of the prism references. + * \param refs pointer to the array of the prism references. * References of the \f$i^{th}\f$ prism is stored in refs[i-1]. - * \param areRequired pointer to the table of the flags saying if the + * \param areRequired pointer to the array of the flags saying if the * prisms are required. areRequired[i-1]=1 if the \f$i^{th}\f$ prism * is required. * \return 0 if failed, 1 otherwise. @@ -1604,11 +1729,11 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM int* isRequired); /** * \param mesh pointer to the mesh structure. - * \param tria pointer to the table of the triangles vertices + * \param tria pointer to the array of the triangles vertices * Vertices of the \f$i^{th}\f$ tria are stored in tria[(i-1)*3]\@3. - * \param refs pointer to the table of the triangles references. + * \param refs pointer to the array of the triangles references. * refs[i-1] is the ref of the \f$i^{th}\f$ tria. - * \param areRequired pointer to table of the flags saying if triangles + * \param areRequired pointer to array of the flags saying if triangles * are required. areRequired[i-1]=1 if the \f$i^{th}\f$ tria * is required. * \return 0 if failed, 1 otherwise. @@ -1655,11 +1780,11 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM MMG5_int* ref, int* isRequired); /** * \param mesh pointer to the mesh structure. - * \param quads pointer to the table of the quadrilaterals vertices + * \param quads pointer to the array of the quadrilaterals vertices * Vertices of the \f$i^{th}\f$ quadra are stored in tria[(i-1)*4]\@4. - * \param refs pointer to the table of the quadrilaterals references. + * \param refs pointer to the array of the quadrilaterals references. * refs[i-1] is the ref of the \f$i^{th}\f$ quadra. - * \param areRequired pointer to table of the flags saying if quadrilaterals + * \param areRequired pointer to array of the flags saying if quadrilaterals * are required. areRequired[i-1]=1 if the \f$i^{th}\f$ quadra * is required. * \return 0 if failed, 1 otherwise. @@ -1704,6 +1829,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG3D_EXPORT int MMG3D_Get_edge(MMG5_pMesh mesh, MMG5_int* e0, MMG5_int* e1, MMG5_int* ref, int* isRidge, int* isRequired); /** + * \brief Set the vertices and reference of all edges in a mesh. + * * \param mesh pointer to the mesh structure. * \param edges pointer to the array of edges. * Vertices of the \f$i^{th}\f$ edge are stored in edge[(i-1)*2]\@2. @@ -1722,6 +1849,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM * */ LIBMMG3D_EXPORT int MMG3D_Set_edges(MMG5_pMesh mesh, MMG5_int *edges, MMG5_int* refs); + /** * \param mesh pointer to the mesh structure. * \param edges pointer to the array of edges. @@ -1804,7 +1932,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG3D_EXPORT int MMG3D_Get_scalarSol(MMG5_pSol met, double* s); /** * \param met pointer to the sol structure. - * \param s table of the scalar solutions at mesh vertices. s[i-1] is + * \param s array of the scalar solutions at mesh vertices. s[i-1] is * the solution at vertex i. * \return 0 if failed, 1 otherwise. * @@ -1839,7 +1967,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG3D_EXPORT int MMG3D_Get_vectorSol(MMG5_pSol met, double* vx, double* vy, double* vz); /** * \param met pointer to the sol structure. - * \param sols table of the solutions at mesh vertices. sols[3*(i-1)]\@3 is + * \param sols array of the solutions at mesh vertices. sols[3*(i-1)]\@3 is * the solution at vertex i. * \return 0 if failed, 1 otherwise. * @@ -1878,7 +2006,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM double *m22,double *m23, double *m33); /** * \param met pointer to the sol structure. - * \param sols table of the solutions at mesh vertices. + * \param sols array of the solutions at mesh vertices. * sols[6*(i-1)]\@6 is the solution at vertex i. * \return 0 if failed, 1 otherwise. * @@ -1918,7 +2046,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM /** * \param sol pointer to the array of solutions * \param i position of the solution field that we want to get. - * \param s table of the solutions at mesh vertices. The solution at vertex \a k + * \param s array of the solutions at mesh vertices. The solution at vertex \a k * is given by s[k-1] for a scalar sol, s[3*(k-1)]\@3 for a vectorial solution * and s[6*(k-1)]\@6 for a tensor solution. * @@ -1956,6 +2084,9 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG3D_EXPORT int MMG3D_Get_iparameter(MMG5_pMesh mesh, MMG5_int iparam); /** + * \brief Add a tetrahedron with vertices \a v0, \a v1, \a v2, \a v3 and reference + * \a ref at the first available position of the mesh. + * * \param mesh pointer to the mesh structure. * \param v0 first vertex of tetrahedron. * \param v1 second vertex of tetrahedron. @@ -1963,12 +2094,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM * \param v3 fourth vertex of tetrahedron. * \param ref tetrahedron reference. * - * \return 0 if unable to create the tetra, the index of the new tetra if the - * new tetra has strictly positive area, -the index of the new tetra if it has a - * zero area or if it has been reorientated. - * - * Add a tetrahedra of vertices \a v0, \a v1,\a v2,\a v3 and reference - * \a ref at the first available position of the mesh. + * \return 0 if unable to create the tetrahedron, the unit-offset index of the new tet if it + * has strictly positive volume, a negative index if it has a zero or negative volume. * * \remark Fortran interface: * > SUBROUTINE MMG3D_ADD_TETRAHEDRON(mesh,v0,v1,v2,v3,ref,retval)\n @@ -2456,7 +2583,7 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol /** * \param starter dummy argument used to initialize the variadic argument * list. - * \param ... variadic arguments that depend to the library function that you + * \param ... variadic arguments that depend on the library function that you * have call. * * For the MMG3D_mmg3dlib function, you need @@ -2489,7 +2616,7 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol /** * \param starter dummy argument used to initialize the variadic argument * list. - * \param ... variadic arguments that depend to the library function that you + * \param ... variadic arguments that depend on the library function that you * have call. * * For the MMG3D_mmg3dlib function, you need @@ -2524,7 +2651,7 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol /** * \param starter dummy argument used to initialize the variadic argument * list. - * \param ... variadic arguments that depend to the library function that you + * \param ... variadic arguments that depend on the library function that you * have call. * * For the MMG3D_mmg3dlib function, you need @@ -2714,7 +2841,7 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol * \param critmin minimum quality for elements. * \param lmin minimum edge length. * \param lmax maximum ede length. - * \param eltab table of invalid elements. + * \param eltab array of invalid elements. * \param metRidTyp Type of storage of ridges metrics: 0 for classic storage * (before the MMG5_defsiz call), 1 for special storage (after this call). * @@ -2737,7 +2864,7 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol * \param mesh pointer to the mesh structure. * \param met pointer to the sol structure. * \param critmin minimum quality for elements. - * \param eltab pointer to the table of invalid elements. + * \param eltab pointer to the array of invalid elements. * \param metRidTyp Type of storage of ridges metrics: 0 for classic storage * (before the MMG5_defsiz call), 1 for special storage (after this call). * @@ -2760,7 +2887,7 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol * \param met pointer to the sol structure. * \param lmin minimum edge length. * \param lmax maximum ede length. - * \param eltab table of invalid elements. + * \param eltab array of invalid elements. * \param metRidTyp Type of storage of ridges metrics: 0 for classic storage * (before the MMG5_defsiz call), 1 for special storage (after this call). * @@ -2789,7 +2916,7 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol * \brief Return adjacent elements of a tetrahedron. * \param mesh pointer to the mesh structure. * \param kel tetrahedron index. - * \param listet pointer to the table of the 4 tetra adjacent to \a kel. + * \param listet pointer to the array of the 4 tetra adjacent to \a kel. * (the index is 0 if there is no adjacent) * \return 1. * @@ -2834,7 +2961,7 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol * \param pack we pack the mesh at function begining if \f$pack=1\f$. * \return 0 if failed, 1 otherwise. * - * Create table of adjacency. Set pack variable to 0 for a compact + * Create array of adjacency. Set pack variable to 0 for a compact * mesh and to 1 for a mesh that need to be packed. * * \remark Fortran interface: From fab659f086dab7247aef9265c79fe23e75ac3031 Mon Sep 17 00:00:00 2001 From: Mark Potse Date: Sun, 3 Mar 2024 19:16:17 +0100 Subject: [PATCH 09/11] added \brief tags for all functions declared in libmmg3d.h, and fixed lanuage errors --- src/mmg3d/inout_3d.c | 9 + src/mmg3d/libmmg3d.h | 443 +++++++++++++++++++++++++++++-------------- 2 files changed, 308 insertions(+), 144 deletions(-) diff --git a/src/mmg3d/inout_3d.c b/src/mmg3d/inout_3d.c index 9edef4b32..7475932b3 100644 --- a/src/mmg3d/inout_3d.c +++ b/src/mmg3d/inout_3d.c @@ -1115,6 +1115,15 @@ int MMG3D_loadMshMesh(MMG5_pMesh mesh,MMG5_pSol sol,const char *filename) { return ier; } +/* This is an API function. It is documented in the header. + * + * This function reads a 3D mesh and 0 or 1 data fields in MSH file format (.msh + * extension). We read only low-order points, edges, triangles, quadrangles, + * tetrahedra and prisms. + * + * It returns 0 if the file is not found, -1 if it fails for another reason (mem + * lack, file format...), 1 if success. + */ int MMG3D_loadMshMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol,const char *filename) { FILE* inm; int ier; diff --git a/src/mmg3d/libmmg3d.h b/src/mmg3d/libmmg3d.h index 6446efd81..5f7cb3d03 100644 --- a/src/mmg3d/libmmg3d.h +++ b/src/mmg3d/libmmg3d.h @@ -1416,8 +1416,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara * \param br new level-set base reference. * \return 0 if failed, 1 otherwise. * - * Set a new level-set base reference of ref \a br in ls discretization - * mode. Base references are boundary conditions to which implicit domain can + * Set a new level-set base reference of ref \a br in LS discretization + * mode. Base references are boundary conditions to which implicit domains can * be attached. All implicit volumes that are not attached to listed base * references are deleted as spurious volumes by the \a rmc option. * @@ -1432,8 +1432,11 @@ LIBMMG3D_EXPORT int MMG3D_Set_inputParamName(MMG5_pMesh mesh, const char* fpara LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MMG5_int br); -/** recover datas */ +/** recover data */ /** + * \brief Get the number of vertices, tetrahedra, prisms, triangles, + * quadrilaterals and edges of the mesh. + * * \param mesh pointer to the mesh structure. * \param np pointer to the number of vertices. * \param ne pointer to the number of tetrahedra. @@ -1443,9 +1446,6 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM * \param na pointer to the number of edges. * \return 1. * - * Get the number of vertices, tetrahedra, prisms, triangles, quadrilaterals and - * edges of the mesh. - * * \remark Fortran interface: * > SUBROUTINE MMG3D_GET_MESHSIZE(mesh,np,ne,nprism,nt,nquad,na,retval)\n * > MMG5_DATA_PTR_T,INTENT(INOUT) :: mesh\n @@ -1456,7 +1456,10 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG3D_EXPORT int MMG3D_Get_meshSize(MMG5_pMesh mesh, MMG5_int* np, MMG5_int* ne,MMG5_int *nprism, MMG5_int* nt, MMG5_int* nquad, MMG5_int* na); + /** + * \brief Get the number of elements, dimension, and type of a solution structure. + * * \param mesh pointer to the mesh structure. * \param sol pointer to the sol structure. * \param typEntity pointer to the type of entities to which solutions @@ -1466,8 +1469,6 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM * ...) * \return 1. * - * Get the solution number, dimension and type. - * * \remark Fortran interface: * > SUBROUTINE MMG3D_GET_SOLSIZE(mesh,sol,typEntity,np,typSol,retval)\n * > MMG5_DATA_PTR_T,INTENT(INOUT) :: mesh,sol\n @@ -1479,7 +1480,10 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG3D_EXPORT int MMG3D_Get_solSize(MMG5_pMesh mesh, MMG5_pSol sol, int* typEntity, MMG5_int* np,int* typSol); + /** + * \brief Get the number of elements and dimension of a solution defined on vertices. + * * \param mesh pointer to the mesh structure. * \param sol pointer to an array of sol structure. * \param nsols pointer to the number of solutions per entity. @@ -1489,8 +1493,6 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM * * \return 1. * - * Get the solution number, dimension and type. - * * \remark Fortran interface: * > SUBROUTINE MMG3D_GET_SOLSATVERTICESSIZE(mesh,sol,nsols,nentities,typSol,retval)\n * > MMG5_DATA_PTR_T,INTENT(INOUT) :: mesh,sol\n @@ -1503,7 +1505,11 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG3D_EXPORT int MMG3D_Get_solsAtVerticesSize(MMG5_pMesh mesh, MMG5_pSol* sol,int *nsols, MMG5_int* nentities,int* typSol); + /** + * \brief Get the coordinates \a c0, \a c1,\a c2 and reference \a ref of the + * next vertex of \a mesh. + * * \param mesh pointer to the mesh structure. * \param c0 pointer to the coordinate of the point along the first * dimension. @@ -1516,8 +1522,11 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM * \param isRequired pointer to the flag saying if point is required. * \return 1. * - * Get coordinates \a c0, \a c1,\a c2 and reference \a ref of next - * vertex of mesh. + * This function retrieves the coordinates \a c0, \a c1,\a c2 and reference \a + * ref of the next vertex of a mesh. It is meant to be used in a loop over all + * vertices. When this function has been called as many times as there are + * vertices, the internal loop counter will be reset. To obtain data for a + * specific vertex, the \a MMG3D_GetByIdx_vertex function can be used instead. * * \remark Fortran interface: * > SUBROUTINE MMG3D_GET_VERTEX(mesh,c0,c1,c2,ref,isCorner,isRequired, &\n @@ -1534,6 +1543,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM MMG5_int* ref,int* isCorner, int* isRequired); /** + * \brief Get the coordinates and reference of a specific vertex in the mesh. + * * \param mesh pointer to the mesh structure. * \param c0 pointer to the coordinate of the point along the first dimension. * \param c1 pointer to the coordinate of the point along the second dimension. @@ -1591,7 +1602,10 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG3D_EXPORT int MMG3D_Get_vertices(MMG5_pMesh mesh, double* vertices, MMG5_int* refs, int* areCorners, int* areRequired); + /** + * \brief Get the vertices and reference of the next tetrahedron in the mesh. + * * \param mesh pointer to the mesh structure. * \param v0 pointer to the first vertex of tetrahedron. * \param v1 pointer to the second vertex of tetrahedron. @@ -1602,8 +1616,10 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM * required. * \return 0 if failed, 1 otherwise. * - * Get vertices \a v0, \a v1, \a v2, \a v3 and reference \a ref of - * next tetra of mesh. + * This function retrieves the vertices \a v0, \a v1, \a v2, \a v3 and reference + * \a ref of the next tetrahedron of \a mesh. It is meant to be called in a loop + * over all tetrahedra. When it has been called as many times as there are + * tetrahedra, the internal loop counter will be reset. * * \remark Fortran interface: * > SUBROUTINE MMG3D_GET_TETRAHEDRON(mesh,v0,v1,v2,v3,ref,isRequired,&\n @@ -1618,19 +1634,20 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG3D_EXPORT int MMG3D_Get_tetrahedron(MMG5_pMesh mesh, MMG5_int* v0, MMG5_int* v1, MMG5_int* v2, MMG5_int* v3,MMG5_int* ref, int* isRequired); + /** + * \brief Get the vertices and reference of all tetrahedra in the mesh. + * * \param mesh pointer to the mesh structure. - * \param tetra pointer to the array of the tetrahedra vertices. - * Vertices of the \f$i^{th}\f$ tetra are stored in tetra[(i-1)*4]\@4. + * \param tetra pointer to the array where the vertices are to be stored. + * Vertices of the \f$i^{th}\f$ tetra are stored in tetra[(i-1)*4] to tetra[(i-1)*4+3] * \param refs pointer to the array of the tetrahedron references. * References of the \f$i^{th}\f$ tetra is stored in refs[i-1]. * \param areRequired pointer to the array of the flags saying if the - * tetrahedra are required. areRequired[i-1]=1 if the \f$i^{th}\f$ tetra + * tetrahedra are required. areRequired[i-1]=1 if the \f$i^{th}\f$ tetrahedron * is required. * \return 0 if failed, 1 otherwise. * - * Get vertices and references of the mesh tetrahedra. - * * \remark Fortran interface: (commentated in order to allow to pass \%val(0) * instead of the refs, areCorners or areRequired arrays) * @@ -1646,7 +1663,10 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG3D_EXPORT int MMG3D_Get_tetrahedra(MMG5_pMesh mesh, MMG5_int* tetra,MMG5_int* refs, int* areRequired); + /** + * \brief Get the vertices and reference of the next prism in the mesh. + * * \param mesh pointer to the mesh structure. * \param v0 pointer to the first vertex of prism. * \param v1 pointer to the second vertex of prism. @@ -1659,8 +1679,10 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM * required. * \return 0 if failed, 1 otherwise. * - * Get vertices \a v0, \a v1, \a v2, \a v3, \a v4, \a v5 and reference \a ref of - * next prism of mesh. + * This function retrieves the vertices \a v0, \a v1, \a v2, \a v3, \a v4, \a v5 + * and reference \a ref of the next prism of \a mesh. It is meant to be called + * in a loop over all prisms. When it has been called as many times as there are + * prisms, the internal loop counter will be reset. * * \remark Fortran interface: * > SUBROUTINE MMG3D_GET_PRISM(mesh,v0,v1,v2,v3,v4,v5,ref,isRequired,&\n @@ -1675,19 +1697,20 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG3D_EXPORT int MMG3D_Get_prism(MMG5_pMesh mesh, MMG5_int* v0, MMG5_int* v1, MMG5_int* v2, MMG5_int* v3,MMG5_int* v4,MMG5_int* v5,MMG5_int* ref, int* isRequired); + /** + * \brief Get the vertices and references of all prisms in the mesh. + * * \param mesh pointer to the mesh structure. - * \param prisms pointer to the array of the prisms vertices. - * Vertices of the \f$i^{th}\f$ prism are stored in prisms[(i-1)*6]\@6. + * \param prisms pointer to the array where the vertices are to be stored + * Vertices of the \f$i^{th}\f$ prism are stored in prisms[(i-1)*6] to prisms[(i-1)*6+5]. * \param refs pointer to the array of the prism references. - * References of the \f$i^{th}\f$ prism is stored in refs[i-1]. + * The reference of the \f$i^{th}\f$ prism is stored in refs[i-1]. * \param areRequired pointer to the array of the flags saying if the * prisms are required. areRequired[i-1]=1 if the \f$i^{th}\f$ prism * is required. * \return 0 if failed, 1 otherwise. * - * Get vertices and references of the mesh prisms. - * * \remark Fortran interface: (commentated in order to allow to pass \%val(0) * instead of the refs, areCorners or areRequired arrays) * @@ -1703,7 +1726,10 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG3D_EXPORT int MMG3D_Get_prisms(MMG5_pMesh mesh, MMG5_int* prisms,MMG5_int* refs, int* areRequired); + /** + * \brief Get the vertices and reference of the next triangle in the mesh. + * * \param mesh pointer to the mesh structure. * \param v0 pointer to the first vertex of triangle. * \param v1 pointer to the second vertex of triangle. @@ -1712,8 +1738,10 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM * \param isRequired pointer to the flag saying if triangle is required. * \return 0 if failed, 1 otherwise. * - * Get vertices \a v0,\a v1,\a v2 and reference \a ref of next - * triangle of mesh. + * This function retrieves the vertices \a v0, \a v1, \a v2, and reference \a + * ref of the next triangle of \a mesh. It is meant to be called in a loop over + * all triangles. When it has been called as many times as there are triangles, + * the internal loop counter will be reset. * * \remark Fortran interface: * > SUBROUTINE MMG3D_GET_TRIANGLE(mesh,v0,v1,v2,ref,isRequired,retval)\n @@ -1727,19 +1755,20 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG3D_EXPORT int MMG3D_Get_triangle(MMG5_pMesh mesh, MMG5_int* v0, MMG5_int* v1, MMG5_int* v2, MMG5_int* ref, int* isRequired); + /** + * \brief Get the vertices and references of all triangles in the mesh. + * * \param mesh pointer to the mesh structure. - * \param tria pointer to the array of the triangles vertices - * Vertices of the \f$i^{th}\f$ tria are stored in tria[(i-1)*3]\@3. - * \param refs pointer to the array of the triangles references. - * refs[i-1] is the ref of the \f$i^{th}\f$ tria. + * \param tria pointer to the array where the vertices are to be stored + * Vertices of the \f$i^{th}\f$ triangle are stored in tria[(i-1)*3] to tria[(i-1)*3+2]. + * \param refs pointer to the array where the references are to be stored. + * refs[i-1] is the reference of the \f$i^{th}\f$ triangle. * \param areRequired pointer to array of the flags saying if triangles * are required. areRequired[i-1]=1 if the \f$i^{th}\f$ tria * is required. * \return 0 if failed, 1 otherwise. * - * Get vertices and references of the mesh triangles. - * * \remark Fortran interface: (Commentated in order to allow to pass \%val(0) * instead of the refs or areRequired arrays) * @@ -1754,7 +1783,10 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG3D_EXPORT int MMG3D_Get_triangles(MMG5_pMesh mesh, MMG5_int* tria, MMG5_int* refs, int* areRequired); + /** + * \brief Get the vertices and reference of the next quadrilateral of the mesh. + * * \param mesh pointer to the mesh structure. * \param v0 pointer to the first vertex of quadrilateral. * \param v1 pointer to the second vertex of quadrilateral. @@ -1764,8 +1796,10 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM * \param isRequired pointer to the flag saying if quadrilateral is required. * \return 0 if failed, 1 otherwise. * - * Get vertices \a v0,\a v1,\a v2,\a v3 and reference \a ref of next - * quadrilateral of mesh. + * Get the vertices \a v0,\a v1,\a v2,\a v3 and reference \a ref of the next + * quadrilateral of mesh. This function is meant to be called in a loop over all + * quadrilaterals. When it has been called as many times as there are + * quadrilaterals, the internal loop counter will be reset. * * \remark Fortran interface: * > SUBROUTINE MMG3D_GET_QUADRILATERAL(mesh,v0,v1,v2,v3,ref,isRequired,retval)\n @@ -1778,19 +1812,20 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG3D_EXPORT int MMG3D_Get_quadrilateral(MMG5_pMesh mesh, MMG5_int* v0, MMG5_int* v1, MMG5_int* v2,MMG5_int* v3, MMG5_int* ref, int* isRequired); + /** + * \brief Get the vertices and references of all quadrilaterals of the mesh. + * * \param mesh pointer to the mesh structure. - * \param quads pointer to the array of the quadrilaterals vertices - * Vertices of the \f$i^{th}\f$ quadra are stored in tria[(i-1)*4]\@4. + * \param quads pointer to the array where the vertices will be stored. + * Vertices of the \f$i^{th}\f$ quadrilateral are stored in quads[(i-1)*4] to quads[(i-1)*4+3]. * \param refs pointer to the array of the quadrilaterals references. - * refs[i-1] is the ref of the \f$i^{th}\f$ quadra. + * refs[i-1] is the ref of the \f$i^{th}\f$ quadrilateral. * \param areRequired pointer to array of the flags saying if quadrilaterals - * are required. areRequired[i-1]=1 if the \f$i^{th}\f$ quadra + * are required. areRequired[i-1]=1 if the \f$i^{th}\f$ quadrilateral * is required. * \return 0 if failed, 1 otherwise. * - * Get vertices and references of the mesh quadrilaterals. - * * \remark Fortran interface: (Commentated in order to allow to pass \%val(0) * instead of the refs or areRequired arrays) * @@ -1805,7 +1840,10 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG3D_EXPORT int MMG3D_Get_quadrilaterals(MMG5_pMesh mesh, MMG5_int* quads, MMG5_int* refs, int* areRequired); + /** + * \brief Get the vertices and reference of the next edge in the mesh. + * * \param mesh pointer to the mesh structure. * \param e0 pointer to the first extremity of the edge. * \param e1 pointer to the second extremity of the edge. @@ -1814,7 +1852,10 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM * \param isRequired pointer to the flag saying if the edge is required. * \return 0 if failed, 1 otherwise. * - * Get extremities \a e0, \a e1 and reference \a ref of next edge of mesh. + * This function retrieves the extremities \a e0, \a e1 and reference \a ref of + * next edge of \a mesh. It is meant to be called in a loop over all edges. When + * it has been called as many times as there are edges in the mesh, the internal + * edge counter will be reset. * * \remark Fortran interface: * > SUBROUTINE MMG3D_GET_EDGE(mesh,e0,e1,ref,isRidge,isRequired,retval)\n @@ -1828,17 +1869,16 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG3D_EXPORT int MMG3D_Get_edge(MMG5_pMesh mesh, MMG5_int* e0, MMG5_int* e1, MMG5_int* ref, int* isRidge, int* isRequired); + /** - * \brief Set the vertices and reference of all edges in a mesh. + * \brief Set the vertices and references of all edges in a mesh. * * \param mesh pointer to the mesh structure. * \param edges pointer to the array of edges. - * Vertices of the \f$i^{th}\f$ edge are stored in edge[(i-1)*2]\@2. + * The vertices of the \f$i^{th}\f$ edge should be given in edge[(i-1)*2] and edge[(i-1)*2+1]. * \param refs edges references. refs[i-1] is the ref of the \f$i^{th}\f$ edge. * \return 0 if failed, 1 otherwise. * - * Set vertices and references of the mesh edges. - * * \remark Fortran interface: * > SUBROUTINE MMG3D_SET_EDGES(mesh,edges,refs,retval)\n * > MMG5_DATA_PTR_T,INTENT(INOUT) :: mesh\n @@ -1851,16 +1891,16 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG3D_EXPORT int MMG3D_Set_edges(MMG5_pMesh mesh, MMG5_int *edges, MMG5_int* refs); /** + * \brief Get the vertices and references of all edges in a mesh. + * * \param mesh pointer to the mesh structure. * \param edges pointer to the array of edges. - * Vertices of the \f$i^{th}\f$ edge are stored in edge[(i-1)*2]\@2. + * The vertices of the \f$i^{th}\f$ edge are stored in edge[(i-1)*2] and edge[(i-1)*2+1]. * \param refs edges references. refs[i-1] is the ref of the \f$i^{th}\f$ edge. * \param areRidges 1 if the edge is a ridge, 0 otherwise. * \param areRequired 1 if the edge is required, 0 otherwise. * \return 0 if failed, 1 otherwise. * - * Get vertices and references of the mesh edges. - * * \remark Fortran interface: * > SUBROUTINE MMG3D_GET_EDGES(mesh,edges,refs,areRidges,areRequired,retval)\n * > MMG5_DATA_PTR_T,INTENT(INOUT) :: mesh\n @@ -1873,7 +1913,10 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG3D_EXPORT int MMG3D_Get_edges(MMG5_pMesh mesh,MMG5_int *edges,MMG5_int* refs, int *areRidges,int *areRequired); + /** + * \brief Get the normal orientation at a single mesh vertex. + * * \param mesh pointer to the mesh structure. * \param k point index * \param n0 x componant of the normal at point \a k. @@ -1882,7 +1925,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM * * \return 1 if success. * - * Get normals (n0,n1,n2) at point \a k. + * This function retrieves the normal (n0,n1,n2) at vertex \a k. * * \remark Fortran interface: * > SUBROUTINE MMG3D_GET_NORMALATVERTEX(mesh,k,n0,n1,n2,retval)\n @@ -1897,6 +1940,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM double *n2) ; /** + * \brief Get the quality measure of a single tetrahedron in the mesh. + * * \param mesh pointer to the mesh structure. * \param met pointer to the metric structure. * \param k index of the tetra for which we want to get the quality. @@ -1915,11 +1960,16 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG3D_EXPORT double MMG3D_Get_tetrahedronQuality(MMG5_pMesh mesh,MMG5_pSol met, MMG5_int k); /** + * \brief Get the next element of a scalar solution structure defined at vertices. + * * \param met pointer to the sol structure. * \param s pointer to the scalar solution value. * \return 0 if failed, 1 otherwise. * - * Get solution \a s of next vertex of mesh. + * This function retrieves the solution \a s of the next vertex of \a mesh. It + * is meant to be called in a loop over all vertices. When it has been called as + * many times as there are vertices in the mesh, the internal loop counter will + * be reset. * * \remark Fortran interface: * > SUBROUTINE MMG3D_GET_SCALARSOL(met,s,retval)\n @@ -1930,14 +1980,15 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM * */ LIBMMG3D_EXPORT int MMG3D_Get_scalarSol(MMG5_pSol met, double* s); + /** + * \brief Get all elements of a scalar solution structure defined at vertices. + * * \param met pointer to the sol structure. - * \param s array of the scalar solutions at mesh vertices. s[i-1] is - * the solution at vertex i. + * \param s array of the scalar solutions at mesh vertices. + * The solution at vertex i will be stored in s[i-1]. * \return 0 if failed, 1 otherwise. * - * Get solutions at mesh vertices. - * * \remark Fortran interface: * > SUBROUTINE MMG3D_GET_SCALARSOLS(met,s,retval)\n * > MMG5_DATA_PTR_T,INTENT(INOUT) :: met\n @@ -1947,14 +1998,20 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM * */ LIBMMG3D_EXPORT int MMG3D_Get_scalarSols(MMG5_pSol met, double* s); + /** + * \brief Get the next element of a vector solution structure defined at vertices. + * * \param met pointer to the sol structure. * \param vx x value of the vectorial solution. * \param vy y value of the vectorial solution. * \param vz z value of the vectorial solution. * \return 0 if failed, 1 otherwise. * - * Get vectorial solution \f$(v_x,v_y,vz)\f$ of next vertex of mesh. + * This function retrieves the solution \f$(v_x,v_y,vz)\f$ of the next vertex + * of \a mesh. It is meant to be called in a loop over all vertices. When it has + * been called as many times as there are vertices in the mesh, the internal + * loop counter will be reset. * * \remark Fortran interface: * > SUBROUTINE MMG3D_GET_VECTORSOL(met,vx,vy,vz,retval)\n @@ -1965,7 +2022,10 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM * */ LIBMMG3D_EXPORT int MMG3D_Get_vectorSol(MMG5_pSol met, double* vx, double* vy, double* vz); + /** + * \brief Get all elements of a vector solution structure defined at vertices. + * * \param met pointer to the sol structure. * \param sols array of the solutions at mesh vertices. sols[3*(i-1)]\@3 is * the solution at vertex i. @@ -1982,7 +2042,10 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM * */ LIBMMG3D_EXPORT int MMG3D_Get_vectorSols(MMG5_pSol met, double* sols); + /** + * \brief Get the next element of a tensor solution structure defined at vertices. + * * \param met pointer to the sol structure. * \param m11 pointer to the position (1,1) in the solution tensor. * \param m12 pointer to the position (1,2) in the solution tensor. @@ -1992,7 +2055,11 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM * \param m33 pointer to the position (3,3) in the solution tensor. * \return 0 if failed, 1 otherwise. * - * Get tensorial solution of next vertex of mesh. + * This function retrieves the tensor-valued solution + * \f$(m_{11},m_{12},m_{13},m_{22},m_{23},m_{33})\f$ of the next vertex of \a + * mesh. It is meant to be called in a loop over all vertices. When it has been + * called as many times as there are vertices in the mesh, the internal loop + * counter will be reset. * * \remark Fortran interface: * > SUBROUTINE MMG3D_GET_TENSORSOL(met,m11,m12,m13,m22,m23,m33,retval)\n @@ -2004,10 +2071,13 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM */ LIBMMG3D_EXPORT int MMG3D_Get_tensorSol(MMG5_pSol met, double *m11,double *m12, double *m13, double *m22,double *m23, double *m33); + /** + * \brief Get all elements of a tensor solution structure defined at vertices. + * * \param met pointer to the sol structure. * \param sols array of the solutions at mesh vertices. - * sols[6*(i-1)]\@6 is the solution at vertex i. + * The solution at vertex \a i will be stored in sols[6*(i-1)] to sols[6*(i-1)+5]. * \return 0 if failed, 1 otherwise. * * Get tensorial solutions at mesh vertices. @@ -2021,7 +2091,10 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM * */ LIBMMG3D_EXPORT int MMG3D_Get_tensorSols(MMG5_pSol met, double *sols); + /** + * \brief Get one out of several solutions at a specific vertex. + * * \param sol pointer to the array of solutions * \param i position of the solution field that we want to get. * \param s solution(s) at mesh vertex \a pos. @@ -2043,7 +2116,10 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM * */ LIBMMG3D_EXPORT int MMG3D_Get_ithSol_inSolsAtVertices(MMG5_pSol sol,int i, double* s,MMG5_int pos); + /** + * \brief Get one out of several solutions at all vertices in the mesh. + * * \param sol pointer to the array of solutions * \param i position of the solution field that we want to get. * \param s array of the solutions at mesh vertices. The solution at vertex \a k @@ -2052,8 +2128,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM * * \return 0 if failed, 1 otherwise. * - * Get values of the solution at the ith field of the solution array (\a i from - * 1 to \a nb_sols). + * This function retrieves the values of the solution at the ith field of the + * solution array (\a i from 1 to \a nb_sols). * * \remark Fortran interface: * > SUBROUTINE MMG3D_GET_ITHSOLS_INSOLSATVERTICES(sol,i,s,retval)\n @@ -2067,8 +2143,10 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG3D_EXPORT int MMG3D_Get_ithSols_inSolsAtVertices(MMG5_pSol sol,int i, double* s); /** + * \brief Get the value of an integer parameter of the remesher. + * * \param mesh pointer to the mesh structure. - * \param iparam integer parameter to set (see \a MMG3D_Param structure). + * \param iparam integer parameter to get (see \a MMG3D_Param structure). * \return The value of integer parameter. * * Get the value of integer parameter \a iparam. @@ -2084,8 +2162,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG3D_EXPORT int MMG3D_Get_iparameter(MMG5_pMesh mesh, MMG5_int iparam); /** - * \brief Add a tetrahedron with vertices \a v0, \a v1, \a v2, \a v3 and reference - * \a ref at the first available position of the mesh. + * \brief Add a tetrahedron to the mesh. * * \param mesh pointer to the mesh structure. * \param v0 first vertex of tetrahedron. @@ -2094,6 +2171,9 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM * \param v3 fourth vertex of tetrahedron. * \param ref tetrahedron reference. * + * This function adds a tetrahedron with vertices \a v0, \a v1, \a v2, \a v3 and reference + * \a ref at the first available position of the mesh. + * * \return 0 if unable to create the tetrahedron, the unit-offset index of the new tet if it * has strictly positive volume, a negative index if it has a zero or negative volume. * @@ -2109,6 +2189,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM MMG5_int v2, MMG5_int v3, MMG5_int ref); /** + * \brief Add a vertex to the mesh. + * * \param mesh pointer to the mesh structure. * \param c0 x coor of the new point * \param c1 y coor of the new point @@ -2118,7 +2200,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM * \return 0 if unable to create the point, the index of the new point * otherwise. * - * Add a point of coor \a c0 \a c1 \a c2 and reference + * This function adds a vertex with coordinates \a c0 \a c1 \a c2 and reference * \a ref at the first available position of the mesh. * * \remark Fortran interface: @@ -2135,8 +2217,10 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM /* input/output functions */ /** + * \brief Load a mesh (in .mesh/.mesb format) from file. + * * \param mesh pointer to the mesh structure. - * \param filename name of file. + * \param filename name of the file. * * \return 0 if file is not found, -1 if fail for another reason (mem lack, file * format...), 1 if success. @@ -2153,7 +2237,10 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM * */ LIBMMG3D_EXPORT int MMG3D_loadMesh(MMG5_pMesh mesh,const char *filename); + /** + * \brief Load a mesh and possibly a solution in .msh format from file. + * * \param mesh pointer to the mesh structure. * \param sol pointer to the solution structure. * \param filename name of file. @@ -2161,8 +2248,9 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM * \return 0 if file is not found, -1 if fail for another reason (mem lack, file * format...), 1 if success. * - * Read mesh and 0 or 1 data at MSH file format (.msh extension). We read only - * low-order points, edges, tria, quadra, tetra and prisms. + * This function reads a mesh and 0 or 1 data fields in MSH file format (.msh + * extension). We read only low-order points, edges, triangles, quadrangles, + * tetrahedra and prisms. * * \remark Fortran interface: * > SUBROUTINE MMG3D_LOADMSHMESH(mesh,sol,filename,strlen0,retval)\n @@ -2176,6 +2264,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG3D_EXPORT int MMG3D_loadMshMesh(MMG5_pMesh mesh,MMG5_pSol sol,const char *filename); /** + * \brief Load a mesh and possibly a solution in VTU (VTK) format from file. + * * \param mesh pointer to the mesh structure. * \param met pointer to the metric structure or the NULL pointer. * \param sol pointer to the level-set structure or the NULL pointer. @@ -2184,10 +2274,10 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM * \return 0 if file is not found, -1 if fail for another reason (mem lack, file * format...), 1 if success. * - * Read mesh and 0 or 1 data at VTU (VTK) file format (.vtu extension). We read - * only low-order points, edges, tria, quadra, tetra and prisms. Point and cell - * references must be stored in PointData or CellData whose names contains the - * "medit:ref" keyword. + * This function reads a mesh and 0 or 1 data at VTU (VTK) file format (.vtu + * extension). We read only low-order points, edges, tria, quadra, tetra and + * prisms. Point and cell references must be stored in PointData or CellData + * whose names contain the "medit:ref" keyword. * * \remark Fortran interface: * > SUBROUTINE MMG3D_LOADVTUMESH(mesh,met,sol,filename,strlen0,retval)\n @@ -2199,16 +2289,18 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM * */ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh(MMG5_pMesh mesh,MMG5_pSol met,MMG5_pSol sol,const char *filename); + /** - * \param - * \met,mesh pointer to the mesh structure. + * \brief Load a mesh and multiple solutions in VTU (VTK) format from file. + * + * \param mesh pointer to the mesh structure. * \param sol pointer to the solution structure. * \param filename name of file. * * \return 0 if file is not found, -1 if fail for another reason (mem lack, file * format...), 1 if success. * - * Read mesh a list of data in VTU file format (.vtu extension). We read + * This functionreads a mesh and a list of data in VTU file format (.vtu extension). We read * only low-order points, edges, tria, quadra, tetra and prisms. Point and cell * references must be stored in PointData or CellData whose names contains the * "medit:ref" keyword. @@ -2225,6 +2317,8 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol,const char *filename); /** + * \brief Load a mesh and possibly a solution from a file in VTK format. + * * \param mesh pointer to the mesh structure. * \param met pointer to the metric structure or the NULL pointer. * \param sol pointer to the level-set structure or the NULL pointer. @@ -2233,9 +2327,9 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol * \return 0 if file is not found, -1 if fail for another reason (mem lack, file * format...), 1 if success. * - * Read mesh and 0 or 1 data at VTK file format (.vtu extension). We read + * This function reads a mesh and 0 or 1 data fields at VTK file format (.vtu extension). We read * only low-order points, edges, tria, quadra, tetra and prisms. Point and cell - * references must be stored in PointData or CellData whose names contains the + * references must be stored in PointData or CellData whose names contain the * "medit:ref" keyword. * * \remark Fortran interface: @@ -2248,7 +2342,10 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol * */ LIBMMG3D_EXPORT int MMG3D_loadVtkMesh(MMG5_pMesh mesh,MMG5_pSol met,MMG5_pSol sol,const char *filename); + /** + * \brief Load a mesh and multiple solutions from a file in VTK format. + * * \param mesh pointer to the mesh structure. * \param sol pointer to the solution structure. * \param filename name of file. @@ -2273,6 +2370,8 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT int MMG3D_loadVtkMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol,const char *filename); /** + * \brief Load a mesh and all data from a file in MSH format. + * * \param mesh pointer to the mesh structure. * \param sol pointer to a list of solution structures. * \param filename name of file. @@ -2295,6 +2394,8 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT int MMG3D_loadMshMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol,const char *filename); /** + * \brief Read mesh data in a file whose format depends on the filename extension. + * * \param mesh pointer to the mesh structure. * \param met pointer to the metric structure or the NULL pointer. * \param sol pointer to the level-set structure or the NULL pointer. @@ -2303,8 +2404,6 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol * \return 0 if file is not found, -1 if fail for another reason (mem lack, file * format...), 1 if success. * - * Read mesh data in a file whose format depends on the filename extension. - * * \remark Fortran interface: * > SUBROUTINE MMG3D_LOADGENERICMESH(mesh,met,sol,filename,strlen0,retval)\n * > MMG5_DATA_PTR_T, INTENT(INOUT) :: mesh,met,sol\n @@ -2317,13 +2416,12 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT int MMG3D_loadGenericMesh(MMG5_pMesh mesh,MMG5_pSol met,MMG5_pSol sol,const char *filename); /** + * \brief Save a mesh in .mesh/.meshb format. + * * \param mesh pointer to the mesh structure. * \param filename pointer to the name of file. - * \return 0 if failed, 1 otherwise. * - * Save mesh data. - * * \remark Fortran interface: * > SUBROUTINE MMG3D_SAVEMESH(mesh,filename,strlen0,retval)\n * > MMG5_DATA_PTR_T, INTENT(INOUT) :: mesh\n @@ -2334,7 +2432,10 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol * */ LIBMMG3D_EXPORT int MMG3D_saveMesh(MMG5_pMesh mesh, const char *filename); + /** + * \brief Save a mesh in MSH format, ascii or binary depending on the filename extension. + * * \param mesh pointer to the mesh structure. * \param sol pointer to the solution structure. * \param filename name of file. @@ -2355,6 +2456,8 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT int MMG3D_saveMshMesh(MMG5_pMesh mesh,MMG5_pSol sol,const char *filename); /** + * \brief Save a mesh and data in MSH format, ascii or binary depending on the filename extension. + * * \param mesh pointer to the mesh structure. * \param sol pointer to the solution structure. * \param filename name of file. @@ -2375,13 +2478,16 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol * */ LIBMMG3D_EXPORT int MMG3D_saveMshMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol,const char *filename); + /** + * \brief Save a mesh and possible one solution in VTK format. + * * \param mesh pointer to the mesh structure. * \param sol pointer to the solution structure. * \param filename name of file. * \return 0 if failed, 1 otherwise. * - * Write mesh and 0 or 1 data at Vtk file format (.vtk extension). + * Write mesh and 0 or 1 data in Vtk file format (.vtk extension). * * \remark Fortran interface: * > SUBROUTINE MMG3D_SAVEVTKMESH(mesh,sol,filename,strlen0,retval)\n @@ -2393,13 +2499,16 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol * */ LIBMMG3D_EXPORT int MMG3D_saveVtkMesh(MMG5_pMesh mesh,MMG5_pSol sol,const char *filename); + /** + * \brief Save a mesh and a list of data fields in VTK format. + * * \param mesh pointer to the mesh structure. * \param sol pointer to the solution structure. * \param filename name of file. * \return 0 if failed, 1 otherwise. * - * Write mesh and a list of data fields at Vtk file format (.vtk extension). + * Write mesh and a list of data fields in Vtk file format (.vtk extension). * * \remark Fortran interface: * > SUBROUTINE MMG3D_SAVEVTKMESH_AND_ALLDATA(mesh,sol,filename,strlen0,retval)\n @@ -2411,13 +2520,16 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol * */ LIBMMG3D_EXPORT int MMG3D_saveVtkMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol,const char *filename); + /** + * \brief Save a mesh and possibly on data field in VTU format. + * * \param mesh pointer to the mesh structure. * \param sol pointer to the solution structure. * \param filename name of file. * \return 0 if failed, 1 otherwise. * - * Write mesh and 0 or 1 data at vtu Vtk file format (.vtu extension). + * Write mesh and 0 or 1 data in vtu Vtk file format (.vtu extension). * * \remark Fortran interface: * > SUBROUTINE MMG3D_SAVEVTUMESH(mesh,sol,filename,strlen0,retval)\n @@ -2429,13 +2541,16 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol * */ LIBMMG3D_EXPORT int MMG3D_saveVtuMesh(MMG5_pMesh mesh,MMG5_pSol sol,const char *filename); + /** + * \brief Save a mesh and a list of data fields in VTU format. + * * \param mesh pointer to the mesh structure. * \param sol pointer to the solution structure. * \param filename name of file. * \return 0 if failed, 1 otherwise. * - * Write mesh and a list of data fields at vtu Vtk file format (.vtu extension). + * Write mesh and a list of data fields in vtu Vtk file format (.vtu extension). * * \remark Fortran interface: * > SUBROUTINE MMG3D_SAVEVTUMESH_AND_ALLDATA(mesh,sol,filename,strlen0,retval)\n @@ -2449,11 +2564,13 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT int MMG3D_saveVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol,const char *filename); /** + * \brief Save data in Tetgen's Triangle format. + * * \param mesh pointer to the mesh structure. * \param filename name of the readed file. * \return 0 or -1 if fail, 1 otherwise. * - * Save mesh data at Triangle (or equivalent to Tetgen in 3D) file format. + * Save mesh data in Triangle (or equivalent to Tetgen in 3D) file format. * * \remark Fortran interface: * > SUBROUTINE MMG3D_SAVETETGENMESH(mesh,filename,strlen0,retval)\n @@ -2467,12 +2584,12 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT int MMG3D_saveTetgenMesh(MMG5_pMesh ,const char *); /** + * \brief Save mesh data in a file whose format depends on the filename extension. + * * \param mesh pointer to the mesh structure. * \param filename name of file. * \return 0 if failed, 1 otherwise. * - * Save mesh data in a file whose format depends on the filename extension. - * * \remark Fortran interface: * > SUBROUTINE MMG3D_SAVEGENERICMESH(mesh,sol,filename,strlen0,retval)\n * > MMG5_DATA_PTR_T, INTENT(INOUT) :: mesh,sol\n @@ -2485,6 +2602,8 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT int MMG3D_saveGenericMesh(MMG5_pMesh mesh,MMG5_pSol sol,const char *filename); /** + * \brief Load a metric field (or other solution). + * * \param mesh pointer to the mesh structure. * \param met pointer to the sol structure. * \param filename name of file. @@ -2505,7 +2624,10 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol * */ LIBMMG3D_EXPORT int MMG3D_loadSol(MMG5_pMesh mesh,MMG5_pSol met, const char *filename); + /** + * \brief Load 1 or more solutions in a solution file in medit file format. + * * \param mesh pointer to the mesh structure. * \param sol pointer to the solutions array * \param filename name of file. @@ -2513,8 +2635,6 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol * \return 0 if file is not found, -1 if fail for another reason (mem lack, file * format...), 1 if success. * - * Load 1 or more solutions in a solution file at medit file format. - * * \remark Fortran interface: * > SUBROUTINE MMG3D_LOADALLSOLS(mesh,sol,filename,strlen0,retval)\n * > MMG5_DATA_PTR_T, INTENT(INOUT) :: mesh,sol\n @@ -2527,13 +2647,13 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT int MMG3D_loadAllSols(MMG5_pMesh mesh,MMG5_pSol *sol, const char* filename); /** + * \brief Write isotropic or anisotropic metric. + * * \param mesh pointer to the mesh structure. * \param met pointer to the sol structure. * \param filename name of file. * \return 0 if failed, 1 otherwise. * - * Write isotropic or anisotropic metric. - * * \remark Fortran interface: * > SUBROUTINE MMG3D_SAVESOL(mesh,met,filename,strlen0,retval)\n * > MMG5_DATA_PTR_T, INTENT(INOUT) :: mesh,met\n @@ -2544,14 +2664,15 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol * */ LIBMMG3D_EXPORT int MMG3D_saveSol(MMG5_pMesh mesh,MMG5_pSol met, const char *filename); + /** + * \brief Save 1 or more solutions in medit solution file format + * * \param mesh pointer to the mesh structure. * \param sol pointer to the solutions array * \param filename name of the solution file. * \return 0 or -1 if fail, 1 otherwise. * - * Save 1 or more solutions at medit solution file format - * * \remark Fortran interface: * > SUBROUTINE MMG3D_SAVEALLSOLS(mesh,sol,filename,strlen0,retval)\n * > MMG5_DATA_PTR_T, INTENT(INOUT) :: mesh,sol\n @@ -2564,12 +2685,12 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT int MMG3D_saveAllSols(MMG5_pMesh mesh,MMG5_pSol *sol ,const char *filename); /** + * \brief Deallocate of an array of solution fields + * * \param mesh pointer to the mesh structure. * \param sol pointer to an array of solution structure (that stores solution fields). * \return 1 * - * Deallocation of an array of solution fields - * * \remark Fortran interface: * > SUBROUTINE MMG3D_Free_allSols(mesh,sol,retval)\n * > MMG5_DATA_PTR_T,INTENT(INOUT) :: mesh,sol\n @@ -2581,6 +2702,8 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol /* deallocations */ /** + * \brief Deallocations before return. + * * \param starter dummy argument used to initialize the variadic argument * list. * \param ... variadic arguments that depend on the library function that you @@ -2603,8 +2726,6 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol * * \return 1 if success, 0 if fail * - * Deallocations before return. - * * \remark we pass the structures by reference in order to have argument * compatibility between the library call from a Fortran code and a C code. * @@ -2614,6 +2735,8 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT int MMG3D_Free_all(const int starter,...); /** + * \brief Structure deallocations before return. + * * \param starter dummy argument used to initialize the variadic argument * list. * \param ... variadic arguments that depend on the library function that you @@ -2636,8 +2759,6 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol * * \return 0 if fail, 1 if success * - * Structure deallocations before return. - * * \remark we pass the structures by reference in order to have argument * compatibility between the library call from a Fortran code and a C code. * @@ -2649,6 +2770,8 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT int MMG3D_Free_structures(const int starter,...); /** + * \brief Structure deallocations before return. + * * \param starter dummy argument used to initialize the variadic argument * list. * \param ... variadic arguments that depend on the library function that you @@ -2671,8 +2794,6 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol * * \return 0 if fail, 1 if success * - * Structure deallocations before return. - * * \remark we pass the structures by reference in order to have argument * compatibility between the library call from a Fortran code and a C code. * @@ -2683,14 +2804,14 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol /* library */ /** + * \brief Main "program" for the remesh library. + * * \param mesh pointer to the mesh structure. * \param met pointer to the sol (metric) structure. * \return \ref MMG5_SUCCESS if success, \ref MMG5_LOWFAILURE if fail but a * conform mesh is saved or \ref MMG5_STRONGFAILURE if fail and we can't save * the mesh. * - * Main program for the remesh library. - * * \remark Fortran interface: * > SUBROUTINE MMG3D_MMG3DLIB(mesh,met,retval)\n * > MMG5_DATA_PTR_T, INTENT(INOUT) :: mesh,met\n @@ -2701,9 +2822,11 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT int MMG3D_mmg3dlib(MMG5_pMesh mesh, MMG5_pSol met ); /** + * \brief Main "program" for the level-set discretization library. + * * \param mesh pointer to the mesh structure. * \param sol pointer to the sol (level-set) structure. - * \param met pointer to a sol structure (metric), optionnal. + * \param met pointer to a sol structure (metric), optional. * \return \ref MMG5_SUCCESS if success, \ref MMG5_LOWFAILURE if fail but a * conform mesh is saved or \ref MMG5_STRONGFAILURE if fail and we can't save * the mesh. @@ -2722,6 +2845,8 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT int MMG3D_mmg3dls(MMG5_pMesh mesh, MMG5_pSol sol, MMG5_pSol met ); /** + * \brief Main program for the rigid-body movement library. + * * \param mesh pointer to the mesh structure. * \param met pointer to the sol (output metric) structure. * \param disp pointer to a sol (displacement for the lagrangian motion @@ -2730,8 +2855,6 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol * conform mesh is saved or \ref MMG5_STRONGFAILURE if fail and we can't save * the mesh. * - * Main program for the rigidbody movement library. - * * \remark Fortran interface: * > SUBROUTINE MMG3D_MMG3DMOV(mesh,met,disp,retval)\n * > MMG5_DATA_PTR_T, INTENT(INOUT) :: mesh,met,disp\n @@ -2743,11 +2866,11 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol /** Tools for the library */ /** + * \brief Print the default parameters values. + * * \param mesh pointer to the mesh structure. * \return 0 if fail, 1 if success. * - * Print the default parameters values. - * * \remark Fortran interface: * > SUBROUTINE MMG3D_DEFAULTVALUES(mesh,retval)\n * > MMG5_DATA_PTR_T, INTENT(INOUT) :: mesh\n @@ -2758,6 +2881,8 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT int MMG3D_defaultValues(MMG5_pMesh mesh); /** + * \brief Store command-line arguments. + * * \param argc number of command line arguments. * \param argv command line arguments. * \param mesh pointer to the mesh structure. @@ -2765,14 +2890,14 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol * \param sol pointer to a level-set or displacement * \return 1 if we want to run Mmg after, 0 if not or if fail. * - * Store command line arguments. - * * \remark no matching fortran function. * */ LIBMMG3D_EXPORT int MMG3D_parsar(int argc,char *argv[],MMG5_pMesh mesh,MMG5_pSol met,MMG5_pSol sol); /** + * \brief Read a file containing Local parameters (.mmg3d extension) + * * \param mesh pointer to the mesh structure. * \param met pointer to the sol structure. * \return 1. @@ -2789,12 +2914,13 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol * */ LIBMMG3D_EXPORT int MMG3D_parsop(MMG5_pMesh mesh,MMG5_pSol met); + /** + * \brief Print help for mmg3d options. + * * \param prog pointer to the program name. * \param return 1 if success, 0 if fail. * - * Print help for mmg3d options. - * * \remark Fortran interface: * > SUBROUTINE MMG3D_USAGE(prog,strlen0,retval)\n * > CHARACTER(LEN=*), INTENT(IN) :: prog\n @@ -2804,13 +2930,14 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol * */ LIBMMG3D_EXPORT int MMG3D_usage(char *prog); + /** + * \brief Store the info structure in the mesh structure. + * * \param mesh pointer to the mesh structure. * \param info pointer to the info structure. * \return 1. * - * Store the info structure in the mesh structure. - * * \remark Fortran interface: * > SUBROUTINE MMG3D_STOCKOPTIONS(mesh,info,retval)\n * > MMG5_DATA_PTR_T, INTENT(INOUT) :: mesh,info\n @@ -2819,12 +2946,13 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol * */ LIBMMG3D_EXPORT int MMG3D_stockOptions(MMG5_pMesh mesh, MMG5_Info *info); + /** + * \brief Recover the info structure stored in the mesh structure. + * * \param mesh pointer to the mesh structure. * \param info pointer to the info structure. * - * Recover the info structure stored in the mesh structure. - * * \remark Fortran interface: * > SUBROUTINE MMG3D_DESTOCKOPTIONS(mesh,info)\n * > MMG5_DATA_PTR_T, INTENT(INOUT) :: mesh,info\n @@ -2835,6 +2963,8 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol /** Checks */ /** + * \brief Search invalid elements (in term of quality or edge length) in a mesh. + * * \param mesh pointer to the mesh structure. * \param met pointer to the sol structure (metric). * \param sol pointer to the sol structure (ls or displacement). @@ -2845,8 +2975,6 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol * \param metRidTyp Type of storage of ridges metrics: 0 for classic storage * (before the MMG5_defsiz call), 1 for special storage (after this call). * - * Search invalid elements (in term of quality or edge length). - * * \remark Fortran interface: * > SUBROUTINE MMG3D_MMG3DCHECK(mesh,met,sol,critmin,lmin,lmax,eltab,&\n * > metridtyp,retval)\n @@ -2860,7 +2988,10 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol */ LIBMMG3D_EXPORT int MMG3D_mmg3dcheck(MMG5_pMesh mesh,MMG5_pSol met,MMG5_pSol sol,double critmin, double lmin, double lmax, MMG5_int *eltab,int8_t metRidTyp); + /** + * \brief List bad elements. + * * \param mesh pointer to the mesh structure. * \param met pointer to the sol structure. * \param critmin minimum quality for elements. @@ -2882,7 +3013,10 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol */ LIBMMG3D_EXPORT void MMG3D_searchqua(MMG5_pMesh mesh, MMG5_pSol met, double critmin, MMG5_int *eltab,int8_t metRidTyp); + /** + * \brief List edges that are too short or too long. + * * \param mesh pointer to the mesh structure. * \param met pointer to the sol structure. * \param lmin minimum edge length. @@ -2914,6 +3048,7 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol /** Utils */ /** * \brief Return adjacent elements of a tetrahedron. + * * \param mesh pointer to the mesh structure. * \param kel tetrahedron index. * \param listet pointer to the array of the 4 tetra adjacent to \a kel. @@ -2934,7 +3069,10 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol * */ LIBMMG3D_EXPORT int MMG3D_Get_adjaTet(MMG5_pMesh mesh,MMG5_int kel, MMG5_int listet[4]); + /** + * \brief Compute the length of an edge according to the size prescription. + * * \param ca pointer to the coordinates of the first edge's extremity. * \param cb pointer to the coordinates of the second edge's extremity. * \param ma pointer to the metric associated to the first edge's @@ -2943,8 +3081,8 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol * extremity. * \return edge length. * - * Compute length of edge \f$[ca,cb]\f$ (with \a ca and \a cb - * coordinates of edge extremities) according to the size + * Compute the length of edge \f$[ca,cb]\f$ (with \a ca and \a cb + * coordinates of edge endpoints) according to the size * prescription. * * \remark Fortran interface: @@ -2957,6 +3095,8 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT extern double (*MMG3D_lenedgCoor)(double *ca,double *cb,double *sa,double *sb); /** + * \brief Create array of adjacency. + * * \param mesh pointer to the mesh structure. * \param pack we pack the mesh at function begining if \f$pack=1\f$. * \return 0 if failed, 1 otherwise. @@ -2975,13 +3115,13 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT int MMG3D_hashTetra(MMG5_pMesh mesh, int pack); /** + * \brief Compute isotropic size map according to the mean of the length of the + * edges passing through a point. + * * \param mesh pointer to the mesh structure * \param met pointer to the sol structure * \return 1 if success * - * Compute isotropic size map according to the mean of the length of the - * edges passing through a point. - * * \remark Fortran interface: * > SUBROUTINE MMG3D_DOSOL(mesh,met,retval)\n * > MMG5_DATA_PTR_T, INTENT(INOUT) :: mesh,met\n @@ -2992,12 +3132,14 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT extern int (*MMG3D_doSol)(MMG5_pMesh mesh,MMG5_pSol met); /** + * \brief Compute a constant size map according to the hsiz, hmin and hmax parameters. + * * \param mesh pointer to the mesh structure * \param met pointer to the sol structure * \return 1 if success * - * Compute constant size map according to mesh->info.hsiz, mesh->info.hmin and - * mesh->info.hmax. Update this 3 value if not compatible. + * Compute a constant size map according to mesh->info.hsiz, mesh->info.hmin and + * mesh->info.hmax. Update these 3 values if not compatible. * * \remark Fortran interface: * > SUBROUTINE MMG3D_SET_CONSTANTSIZE(mesh,met,retval)\n @@ -3009,12 +3151,14 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT int MMG3D_Set_constantSize(MMG5_pMesh mesh,MMG5_pSol met); /** + * \brief Swap the m22 and m23 values of the metric. + * * \param mesh pointer to the mesh structure * \param met pointer to the sol structure * \return 1 if success * * Switch the m22 and m23 value of the metric to allow to pass from the API - * storage to the medit one. + * storage to the medit storage. * * \remark Fortran interface: * > SUBROUTINE MMG3D_SWITCH_METRICSTORAGE(mesh,met,retval)\n @@ -3028,12 +3172,12 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol /** To associate function pointers without calling MMG3D_mmg3dlib */ /** + * \brief Set function pointers for caltet, lenedg, lenedgCoor defsiz, gradsiz... + * depending if the metric that was read is anisotropic or isotropic + * * \param mesh pointer to the mesh structure (unused). * \param met pointer to the sol structure (unused). * - * Set function pointers for caltet, lenedg, lenedgCoor defsiz, gradsiz... - * depending if the readed metric is anisotropic or isotropic - * * \remark Fortran interface: * > SUBROUTINE MMG3D_SETFUNC(mesh,met)\n * > MMG5_DATA_PTR_T, INTENT(INOUT) :: mesh,met\n @@ -3043,17 +3187,19 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT void MMG3D_setfunc(MMG5_pMesh mesh,MMG5_pSol met); /** + * \brief Get the number of non-boundary triangles. + * * \param mesh pointer to the mesh structure. - * \param nb_tria pointer to the number of non boundary triangles. + * \param nb_tria pointer to the number of non-boundary triangles. * \return 0 if failed, 1 otherwise. * - * Get the number of non boundary triangles (for DG methods for example). + * Get the number of non-boundary triangles (for DG methods for example). * A triangle is * boundary if it is located at the interface of 2 domains with different * references or if it belongs to one tetra only. * Append these triangles to the list of triangles. * - * \warning reallocate the triangle array and append the internal triangles. + * \warning reallocates the triangle array and appends the internal triangles. * This may modify the behaviour of other functions. * * \remark Fortran interface: @@ -3067,15 +3213,17 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT int MMG3D_Get_numberOfNonBdyTriangles(MMG5_pMesh mesh, MMG5_int* nb_tria); /** + * \brief Get vertices and reference of a non-boundary triangle. + * * \param mesh pointer to the mesh structure. * \param v0 pointer to the firts vertex of the triangle * \param v1 pointer to the second vertex of the triangle. * \param v2 pointer to the third vertex of the triangle. * \param ref pointer to the triangle reference. - * \param idx index of the non boundary triangle to get (between 1 and nb_tria) + * \param idx index of the non-boundary triangle to get (between 1 and nb_tria) * \return 0 if failed, 1 otherwise. * - * Get vertices and reference \a ref of the idx^th non boundary + * Get vertices and reference \a ref of the idx^th non-boundary * triangle (for DG methods for example). A tria is boundary if it is located at * the interface of 2 domains witch different references or if it belongs to one * tetra only. @@ -3093,6 +3241,9 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT int MMG3D_Get_nonBdyTriangle(MMG5_pMesh mesh, MMG5_int* v0, MMG5_int* v1, MMG5_int* v2, MMG5_int* ref, MMG5_int idx); /** + * \brief Get a tetrahedron given one of its triangles and the index by which it + * refers to this triangle (DEPRECATED). + * * \param mesh pointer to the mesh structure. * \param ktri index of the boundary triangle. * \param ktet pointer to an integer that will contains the tetra index. @@ -3100,8 +3251,8 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol * * \return 0 if fail, 1 otherwise * - * Fill \a ktet by the indice of a tetra to which belong a boundary triangle - * and \a iface by the indice of the triangle in the tetra. + * Fill \a ktet by the index of a tetrahedron to which belongs a boundary triangle + * and \a iface by the index of the triangle in the tetra. * * \warning will be deprecated in release 5.5 * @@ -3118,6 +3269,8 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT int MMG3D_Get_tetFromTria(MMG5_pMesh mesh, MMG5_int ktri, MMG5_int *ktet, int *iface); /** + * \brief Get two tetrahedra given a triangle and face indices. + * * \param mesh pointer to the mesh structure. * \param ktri index of the boundary triangle. * \param ktet array of size 2 that will contain the indices of the tetra @@ -3128,9 +3281,9 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol * * \return 0 if fail, 1 otherwise * - * Fill \a ktet by the indices of the tetra to which belong a boundary triangle + * Fill \a ktet by the indices of the tetrahedra that have a boundary triangle * and \a iface by the indices of the faces of the tetras that correspond to the - * triangle. Fill ktet[1] and iface[1] by 0 if the triangle belongs to 1 tetra only. + * triangle. Fill ktet[1] and iface[1] by 0 if the triangle belongs to 1 tetrahedron only. * * \remark Fortran interface: * > SUBROUTINE MMG3D_GET_TETSFROMTRIA(mesh,ktri,ktet,iface,retval)\n @@ -3145,6 +3298,8 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT int MMG3D_Get_tetsFromTria(MMG5_pMesh mesh, MMG5_int ktri, MMG5_int ktet[2], int iface[2]); /** + * \brief Compute the real eigenvalues and eigenvectors of a symmetric matrix + * * \param m upper part of a symmetric matric diagonalizable in |R * \param lambda array of the metric eigenvalues * \param vp array of the metric eigenvectors @@ -3171,12 +3326,12 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT int MMG3D_Compute_eigenv(double m[6],double lambda[3],double vp[3][3]); /** + * \brief Clean data (triangles and edges) linked to isosurface. + * * \param mesh pointer to the mesh sructure * * \return 1 if successful, 0 otherwise. * - * Clean data (triangles and edges) linked to isosurface. - * * \remark Fortran interface: * > SUBROUTINE MMG3D_CLEAN_ISOSURF(mesh,retval)\n * > MMG5_DATA_PTR_T, INTENT(IN) :: mesh\n @@ -3187,11 +3342,11 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol LIBMMG3D_EXPORT int MMG3D_Clean_isoSurf(MMG5_pMesh mesh); /** + * \brief Free the solution structure of a given mesh. + * * \param mesh pointer to the mesh structure * \param sol pointer to the solution structure * - * Free the solution. - * * \remark Fortran interface: * > SUBROUTINE MMG3D_FREE_SOLUTIONS(mesh,sol)\n * > MMG5_DATA_PTR_T, INTENT(INOUT) :: mesh,sol\n From b8c3671d43edb91ee19381c7b3dbaee48dd4d532 Mon Sep 17 00:00:00 2001 From: Mark Potse Date: Sun, 3 Mar 2024 21:11:48 +0100 Subject: [PATCH 10/11] added a little intro to libmmg3d.h, to introduce some terminology --- src/mmg3d/libmmg3d.h | 42 ++++++++++++++++++++++++++++++++++-------- 1 file changed, 34 insertions(+), 8 deletions(-) diff --git a/src/mmg3d/libmmg3d.h b/src/mmg3d/libmmg3d.h index 5f7cb3d03..fad94f482 100644 --- a/src/mmg3d/libmmg3d.h +++ b/src/mmg3d/libmmg3d.h @@ -32,6 +32,32 @@ * name and the opening brace (it creates errors under windows) * \warning Use the MMG3D_ prefix: the MMG5_ prefix will become obsolete. * + * These are the API functions for the mmg3d library. These functions allow to + * load and save meshes and data defined on meshes; add, extract, or modify mesh + * data; and to call the library functions that perform remeshing, level-set + * discretization, and Lagrangian motion. + * + * Meshes are here defined in terms of vertices and three-dimensional objects: + * tetrahedra and prisms. Optionally lower-dimensional entities can be present: + * triangles, quadrilaterals and edges. All of these \a entities can have a + * \a reference: an integer value that can serve as a group identifier. In + * addition mesh entities can have \a attributes such as "ridge" or "required". + * + * Data defined on meshes can be for example functions that are meant for + * level-set discretization, metric tensors that will govern edge lengths, and + * vector fields governing lagrangian motion. These data can be scalar, vector, + * or (symmetric) tensor-valued; and there can be more than one data item + * associated with a mesh entity. These data are often referred to as \a + * solutions. + * + * Three of the functions here are referred to as "programs", because they + * perform the tasks for which Mmg is meant: remeshing, level-set discretization + * and Lagrangian motion. The other functions merely serve to load and save data + * and to perform pre- and post-processing. These programs actually behave much + * like independent programs: they send diagnostic output to stdout and in rare + * cases they may call the exit() function. + * + * * \htmlonly *

Examples

* \endhtmlonly @@ -166,7 +192,7 @@ enum MMG3D_Param { * \remark No fortran interface to allow variadic arguments. * * \warning detected bugs: - * - some points along open-boundaries end up with a normal (while they should not) + * - some points along open boundaries end up with a normal (while they should not) * */ LIBMMG3D_EXPORT int MMG3D_Init_mesh(const int starter,...); @@ -2274,7 +2300,7 @@ LIBMMG3D_EXPORT int MMG3D_Set_lsBaseReference(MMG5_pMesh mesh, MMG5_pSol sol,MM * \return 0 if file is not found, -1 if fail for another reason (mem lack, file * format...), 1 if success. * - * This function reads a mesh and 0 or 1 data at VTU (VTK) file format (.vtu + * This function reads a mesh and 0 or 1 data field in VTU (VTK) file format (.vtu * extension). We read only low-order points, edges, tria, quadra, tetra and * prisms. Point and cell references must be stored in PointData or CellData * whose names contain the "medit:ref" keyword. @@ -2327,7 +2353,7 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol * \return 0 if file is not found, -1 if fail for another reason (mem lack, file * format...), 1 if success. * - * This function reads a mesh and 0 or 1 data fields at VTK file format (.vtu extension). We read + * This function reads a mesh and 0 or 1 data fields in VTK file format (.vtu extension). We read * only low-order points, edges, tria, quadra, tetra and prisms. Point and cell * references must be stored in PointData or CellData whose names contain the * "medit:ref" keyword. @@ -2379,7 +2405,7 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol * \return 0 if file is not found, -1 if fail for another reason (mem lack, file * format...), 1 if success. * - * Read mesh and a list of data at MSH file format (.msh extension). We read only + * Read mesh and a list of data in MSH file format (.msh extension). We read only * low-order points, edges, tria, quadra, tetra and prisms. * * \remark Fortran interface: @@ -2441,7 +2467,7 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol * \param filename name of file. * \return 0 if failed, 1 otherwise. * - * Write mesh and 0 or 1 data at MSH file format (.msh extension). Write binary + * Write mesh and 0 or 1 data in MSH file format (.msh extension). Write binary * file for .mshb extension and ASCII for .msh one. * * \remark Fortran interface: @@ -2464,8 +2490,8 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol * \return 0 if failed, 1 otherwise. * * Write mesh and a list of data fields (that are considered as solutions and - * not metrics, thus, we do nothing over the ridge points) at MSH file format - * (.msh extension). Save file at ASCII format for .msh extension, at binary + * not metrics, thus, we do nothing over the ridge points) in MSH file format + * (.msh extension). Save file in ASCII format for .msh extension, in binary * format for .mshb one. * * \remark Fortran interface: @@ -3225,7 +3251,7 @@ LIBMMG3D_EXPORT int MMG3D_loadVtuMesh_and_allData(MMG5_pMesh mesh,MMG5_pSol *sol * * Get vertices and reference \a ref of the idx^th non-boundary * triangle (for DG methods for example). A tria is boundary if it is located at - * the interface of 2 domains witch different references or if it belongs to one + * the interface of 2 domains with different references or if it belongs to one * tetra only. * * \remark Fortran interface: From 068be5289ceda671d71a5d766abc66d2d7fd5bb5 Mon Sep 17 00:00:00 2001 From: Algiane Froehly Date: Mon, 4 Mar 2024 15:05:42 +0100 Subject: [PATCH 11/11] Fix typos introduced by search and replace command. --- src/mmg2d/analys_2d.c | 4 ++-- src/mmg3d/analys_3d.c | 6 +++--- src/mmgs/analys_s.c | 4 ++-- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/src/mmg2d/analys_2d.c b/src/mmg2d/analys_2d.c index 20bd8a9b8..7da68a639 100644 --- a/src/mmg2d/analys_2d.c +++ b/src/mmg2d/analys_2d.c @@ -773,8 +773,8 @@ int MMG2D_regnor(MMG5_pMesh mesh) { } /** - * \param mesh pointer tos the mesh - * \param pt pointer tos current triangle + * \param mesh pointer to the mesh + * \param pt pointer to current triangle * \param k number of current point * \param c newly computed coordinates (giving negative area) * diff --git a/src/mmg3d/analys_3d.c b/src/mmg3d/analys_3d.c index c1a336b68..d4e1e25bc 100644 --- a/src/mmg3d/analys_3d.c +++ b/src/mmg3d/analys_3d.c @@ -813,8 +813,8 @@ int MMG5_norver(MMG5_pMesh mesh) { } /** - * \param mesh pointer tos the mesh - * \param pt pointer tos current triangle + * \param mesh pointer to the mesh + * \param pt pointer to current triangle * \param k number of current point * \param c newly computed coordinates (giving negative area) * \param n normal of triangle before regularization @@ -881,7 +881,7 @@ static inline int MMG3D_dichotomytria(MMG5_pMesh mesh, MMG5_pTria pt, MMG5_int k } /** - * \param mesh pointer tos the mesh + * \param mesh pointer to the mesh * \param v list of vertices of current tetrahedron * \param k number of current point * \param c input : newly computed coordinates (giving negative area), output : coordinates after dichotomy diff --git a/src/mmgs/analys_s.c b/src/mmgs/analys_s.c index 1aa0a68cd..19fe92959 100644 --- a/src/mmgs/analys_s.c +++ b/src/mmgs/analys_s.c @@ -739,8 +739,8 @@ static int norver(MMG5_pMesh mesh) { } /** - * \param mesh pointer tos the mesh - * \param pt pointer tos current triangle + * \param mesh pointer to the mesh + * \param pt pointer to current triangle * \param k number of current point * \param c newly computed coordinates (giving negative area) * \param n normal of triangle before regularization