songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #8030 from janetournois/Mesh_3-perturber_doc-jtournois 

Mesh_3 - fix perturber doc
This commit is contained in:
Laurent Rineau 2024-02-16 18:03:10 +01:00
parent 7d9070e7bb 51ebe945de
commit d9ebccd627
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Mesh_3/include/CGAL/perturb_mesh_3.h
View File

@ -50,7 +50,7 @@ namespace CGAL {
* \tparam MD a model of the concept `MeshDomain_3` * \tparam MD a model of the concept `MeshDomain_3`
* \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters" * \tparam NamedParameters a sequence of \ref bgl_namedparameters "Named Parameters"
* *
* @param c3t3 the initial mesh and is modified by the algorithm to represent the final optimized mesh * @param c3t3 the initial mesh, modified by the algorithm to represent the final optimized mesh
* @param domain the domain used to create the `c3t3` parameter * @param domain the domain used to create the `c3t3` parameter
* @param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below: * @param np an optional sequence of \ref bgl_namedparameters "Named Parameters" among the ones listed below:
* *
@ -60,18 +60,18 @@ namespace CGAL {
* is stopped. This time is measured using the `Real_timer` class. The default value is * is stopped. This time is measured using the `Real_timer` class. The default value is
* 0 and means that there is no time limit.} * 0 and means that there is no time limit.}
* \cgalParamType{`double`} * \cgalParamType{`double`}
* \cgalParamPrecondition{`0 <= sliver_bound <= 180`} * \cgalParamPrecondition{`time_limit >= 0`}
* \cgalParamDefault{0} * \cgalParamDefault{0}
* \cgalParamNEnd * \cgalParamNEnd
* \cgalParamNBegin{sliver_bound} * \cgalParamNBegin{sliver_bound}
* \cgalParamDescription{is designed to give, in degrees, a targeted lower bound on dihedral angles of mesh cells. * \cgalParamDescription{is designed to give, in degrees, a targeted lower bound on dihedral angles of mesh cells.
* The exudation process considers in turn all the mesh cells that have a smallest dihedral * The function `perturb_mesh_3()` runs as long as steps are successful and step number
* angle less than sliver_bound and tries to make them disappear by weighting their vertices. * `sliver_bound` (after which the worst tetrahedron in the mesh has a smallest angle larger
* The optimization process stops when every cell in the mesh achieves this quality. The * than `sliver_bound` degrees) has not been reached.
* default value is 0 and means that there is no targeted bound: the exuder then runs as long * The default value is 0 and means that there is no targeted bound:
* as it can improve the smallest dihedral angles of the set of cells incident to some vertices.} * the perturber then runs as long as steps are successful.}
* \cgalParamType{`double`} * \cgalParamType{`double`}
* \cgalParamPrecondition{`time_limit >= 0`} * \cgalParamPrecondition{`0 <= sliver_bound <= 180`}
* \cgalParamDefault{0} * \cgalParamDefault{0}
* \cgalParamNEnd * \cgalParamNEnd
* \cgalNamedParamsEnd * \cgalNamedParamsEnd