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

Minor doc changes

This commit is contained in:
Mael Rouxel-Labbé 2017-08-07 11:32:58 +02:00
parent e07a7af4cb
commit c6af3e8755
12 changed files with 21 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Mesh_3/doc/Mesh_3/CGAL/Labeled_mesh_domain_3.h
View File

@ -7,7 +7,7 @@ namespace CGAL {
This class is a model of concept `MeshDomain_3`. This class is a model of concept `MeshDomain_3`.
Any boundary facet is labeled <a,b>, a<b, where a and b are the Any boundary facet is labeled <a,b>, with a<b, where a and b are the
tags of its incident subdomain. tags of its incident subdomain.
Thus, a boundary facet of the domain is labeled <0,b>, where b!=0. Thus, a boundary facet of the domain is labeled <0,b>, where b!=0.

4
Mesh_3/doc/Mesh_3/CGAL/make_mesh_3.h
View File

@ -119,12 +119,12 @@ they are always launched in the order that is a suborder
of the following (see user manual for further details): of the following (see user manual for further details):
*lloyd*, *odt*, *perturb*, *exude*. *lloyd*, *odt*, *perturb*, *exude*.
Also beware, that optimization of the mesh is obtained Beware that optimization of the mesh is obtained
by perturbing mesh vertices and modifying the mesh connectivity by perturbing mesh vertices and modifying the mesh connectivity
and that this has an impact and that this has an impact
on the strict compliance to the refinement criteria. on the strict compliance to the refinement criteria.
Though a strict compliance to mesh criteria Though a strict compliance to mesh criteria
is granted at the end of the Delaunay refinement, this may no longer be true after is guaranteed at the end of the Delaunay refinement, this may no longer be true after
some optimization processes. Also beware that the default behavior does involve some some optimization processes. Also beware that the default behavior does involve some
optimization processes. optimization processes.

2
Mesh_3/doc/Mesh_3/CGAL/refine_mesh_3.h
View File

@ -121,7 +121,7 @@ by perturbing mesh vertices and modifying the mesh connectivity
and that this has an impact and that this has an impact
on the strict compliance to the refinement criteria. on the strict compliance to the refinement criteria.
Though a strict compliance to mesh criteria Though a strict compliance to mesh criteria
is granted at the end of the Delaunay refinement, this may no longer be true after is guaranteed at the end of the Delaunay refinement, this may no longer be true after
some optimization processes. Also beware that the default behavior does involve some some optimization processes. Also beware that the default behavior does involve some
optimization processes. optimization processes.

2
Mesh_3/include/CGAL/Labeled_mesh_domain_3.h
View File

@ -60,7 +60,7 @@ struct Null_subdomain_index {
* - f(p)=0 means that p is outside domain. * - f(p)=0 means that p is outside domain.
* - f(p)=a, a!=0 means that p is inside subdomain a. * - f(p)=a, a!=0 means that p is inside subdomain a.
* *
* Any boundary facet is labelled <a,b>, a<b, where a and b are the * Any boundary facet is labelled <a,b>, with a<b, where a and b are the
* tags of it's incident subdomain. * tags of it's incident subdomain.
* Thus, a boundary facet of the domain is labelled <0,b>, where b!=0. * Thus, a boundary facet of the domain is labelled <0,b>, where b!=0.
*/ */

2
Mesh_3/include/CGAL/Mesh_3/Labeled_mesh_domain_3.h
View File

@ -58,7 +58,7 @@ namespace Mesh_3 {
* - f(p)=0 means that p is outside domain. * - f(p)=0 means that p is outside domain.
* - f(p)=a, a!=0 means that p is inside subdomain a. * - f(p)=a, a!=0 means that p is inside subdomain a.
* *
* Any boundary facet is labelled <a,b>, a<b, where a and b are the * Any boundary facet is labelled <a,b>, with a<b, where a and b are the
* tags of it's incident subdomain. * tags of it's incident subdomain.
* Thus, a boundary facet of the domain is labelled <0,b>, where b!=0. * Thus, a boundary facet of the domain is labelled <0,b>, where b!=0.
*/ */

2
Periodic_3_mesh_3/doc/Periodic_3_mesh_3/CGAL/Labeled_periodic_3_mesh_domain_3.h
View File

@ -7,7 +7,7 @@ namespace CGAL {
This class is a model of concept `Periodic_3MeshDomain_3`. This class is a model of concept `Periodic_3MeshDomain_3`.
Any boundary facet is labeled <a,b>, a<b, where a and b are the Any boundary facet is labeled <a,b>, with a<b, where a and b are the
tags of its incident subdomain. tags of its incident subdomain.
Thus, a boundary facet of the domain is labeled <0,b>, where b!=0. Thus, a boundary facet of the domain is labeled <0,b>, where b!=0.

1
Periodic_3_mesh_3/doc/Periodic_3_mesh_3/CGAL/Periodic_3_mesh_triangulation_3.h
View File

@ -18,6 +18,7 @@ the triangulation type to be used for the 3D periodic triangulation embedding th
`Default` may be used, with default value `Mesh_cell_base_3<Gt, MD, Triangulation_cell_base_with_circumcenter_3<Gt, Triangulation_cell_base_3<Gt, Periodic_3_triangulation_ds_cell_base_3> > >`. `Default` may be used, with default value `Mesh_cell_base_3<Gt, MD, Triangulation_cell_base_with_circumcenter_3<Gt, Triangulation_cell_base_3<Gt, Periodic_3_triangulation_ds_cell_base_3> > >`.
\sa `make_periodic_3_mesh_3()` \sa `make_periodic_3_mesh_3()`
\sa `refine_periodic_3_mesh_3()`
\sa `Mesh_triangulation_3` \sa `Mesh_triangulation_3`

4
Periodic_3_mesh_3/doc/Periodic_3_mesh_3/CGAL/make_periodic_3_mesh_3.h
View File

@ -106,12 +106,12 @@ they are always launched in the order that is a suborder
of the following (see user manual for further details): of the following (see user manual for further details):
*lloyd*, *odt*, *perturb*, *exude*. *lloyd*, *odt*, *perturb*, *exude*.
Also, beware that optimization of the mesh is obtained Beware that optimization of the mesh is obtained
by perturbing mesh vertices and modifying the mesh connectivity by perturbing mesh vertices and modifying the mesh connectivity
and that this has an impact and that this has an impact
on the strict compliance to the refinement criteria. on the strict compliance to the refinement criteria.
Though a strict compliance to mesh criteria Though a strict compliance to mesh criteria
is granted at the end of the Delaunay refinement, this may no longer be true after is guaranteed at the end of the Delaunay refinement, this may no longer be true after
some optimization processes. Also beware that the default behavior does involve some some optimization processes. Also beware that the default behavior does involve some
optimization processes. optimization processes.

4
Periodic_3_mesh_3/doc/Periodic_3_mesh_3/CGAL/refine_periodic_3_mesh_3.h
View File

@ -25,7 +25,7 @@ is further refined afterward.
to refine a previously computed mesh, e.g.: to refine a previously computed mesh, e.g.:
\code{.cpp} \code{.cpp}
C3T3 c3t3 = CGAL::make_mesh_3<C3T3>(domain,criteria); C3T3 c3t3 = CGAL::make_periodic_3_mesh_3<C3T3>(domain,criteria);
CGAL::refine_periodic_3_mesh_3(c3t3, domain, new_criteria); CGAL::refine_periodic_3_mesh_3(c3t3, domain, new_criteria);
\endcode \endcode
@ -106,7 +106,7 @@ of the following (see user manual for further details):
Beware that optimization of the mesh is obtained by perturbing mesh vertices Beware that optimization of the mesh is obtained by perturbing mesh vertices
and modifying the mesh connectivity and that this has an impact on the strict and modifying the mesh connectivity and that this has an impact on the strict
compliance to the refinement criteria. Though a strict compliance to mesh criteria compliance to the refinement criteria. Though a strict compliance to mesh criteria
is granted at the end of the Delaunay refinement, this may no longer be true after is guaranteed at the end of the Delaunay refinement, this may no longer be true after
some optimization processes. Also beware that the default behavior does involve some some optimization processes. Also beware that the default behavior does involve some
optimization processes. optimization processes.

7
Periodic_3_mesh_3/doc/Periodic_3_mesh_3/Concepts/Periodic_3MeshDomain_3.h
View File

@ -8,11 +8,12 @@ The concept `Periodic_3MeshDomain_3` describes the knowledge required on the
object to be discretized. object to be discretized.
The concept `Periodic_3MeshDomain_3` is the concept to be used when the input The concept `Periodic_3MeshDomain_3` is the concept to be used when the input
domain is defined over the three-dimensional flat torus. From a syntaxic point domain is defined over the three-dimensional flat torus. From a syntaxic point
of view, it defines exactly the same requirement as the concept `MeshDomain_3`. of view, it defines exactly the same requirement as the concept `MeshDomain_3`
(thus `Periodic_3MeshDomain_3` refines `MeshDomain_3` without adding any requirement).
However, since periodic meshes are constructed by considering a single fundamental However, since periodic meshes are constructed by considering a single fundamental
domain, the oracles must be more powerful than in `MeshDomain_3` domain, the oracles must be more powerful than described in `MeshDomain_3`
and handle periodicity. and be able to reflect the periodicity of the domain.
For instance, when evaluating the `Do_intersect_surface` oracle for a segment For instance, when evaluating the `Do_intersect_surface` oracle for a segment
that intersects a predicate facet of the fundamental domain, it may be the case that intersects a predicate facet of the fundamental domain, it may be the case
that does not intersect the surface in the domain, but its translated copy that that does not intersect the surface in the domain, but its translated copy that

8
Periodic_3_mesh_3/doc/Periodic_3_mesh_3/PackageDescription.txt
View File

@ -46,14 +46,14 @@ flexibility that is offered in the \ref PkgMesh_3Summary package.}
### Efficiently computing periodic meshes ### ### Efficiently computing periodic meshes ###
A periodic mesh extends by definition infinitely in space. To avoid storing and A periodic mesh extends, by definition, infinitely in space. To avoid storing and
manipulating duplicate points, well-chosen "dummy" points are inserted manipulating duplicate points, well-chosen "dummy" points are inserted
at the beginning of the meshing process, thus ensuring that the triangulation forms at the beginning of the meshing process, thus ensuring that the triangulation forms
at all times a simplicial complex within a single fundamental copy of the domain at all times a simplicial complex within a single fundamental copy of the domain
(see Sections \ref P3Triangulation3secspace and \ref P3Triangulation3secintro (see Sections \ref P3Triangulation3secspace and \ref P3Triangulation3secintro
of the manual of 3D periodic triangulations). of the manual of 3D periodic triangulations).
The meshing process can then be exclusively conducted in the fundamental domain. The meshing process can then be exclusively conducted in the fundamental domain.
This single copy of the complete periodic mesh is then generated using This single copy of the complete periodic mesh is generated using
the three-dimensional mesh generator of %CGAL (see package: \ref PkgMesh_3Summary). the three-dimensional mesh generator of %CGAL (see package: \ref PkgMesh_3Summary).
Since this mesh generator only supports traditional (non-periodic) domains, Since this mesh generator only supports traditional (non-periodic) domains,
it must be provided adapted oracles to handle the periodicity of the input domain it must be provided adapted oracles to handle the periodicity of the input domain
@ -67,8 +67,8 @@ mesh generator with periodic triangulations.
The \ref PkgPeriodic_3_mesh_3 package relies entirely on the \ref PkgMesh_3Concepts The \ref PkgPeriodic_3_mesh_3 package relies entirely on the \ref PkgMesh_3Concepts
and the \ref PkgMesh_3SecondaryConcepts described in the \ref PkgMesh_3Summary package. and the \ref PkgMesh_3SecondaryConcepts described in the \ref PkgMesh_3Summary package.
The following concept is essentially identical to its equivalent in the \ref PkgMesh_3Summary The following concept is essentially identical to the concept `MeshDomain_3`
package but is nevertheless defined for clarity: in the \ref PkgMesh_3Summary package but is nevertheless defined for clarity:
- `Periodic_3MeshDomain_3` - `Periodic_3MeshDomain_3`

2
Periodic_3_mesh_3/include/CGAL/Labeled_periodic_3_mesh_domain_3.h
View File

@ -38,7 +38,7 @@ namespace CGAL
* - f(p)=0 means that p is outside domain. * - f(p)=0 means that p is outside domain.
* - f(p)=a, a!=0 means that p is inside subdomain a. * - f(p)=a, a!=0 means that p is inside subdomain a.
* *
* Any boundary facet is labelled <a,b>, a<b, where a and b are the * Any boundary facet is labelled <a,b>, with a<b, where a and b are the
* tags of its incident subdomain. * tags of its incident subdomain.
* Thus, a boundary facet of the domain is labelled <0,b>, where b!=0. * Thus, a boundary facet of the domain is labelled <0,b>, where b!=0.
*/ */