cgal/Mesh_2/doc/Mesh_2/PackageDescription.txt

73 lines
2.7 KiB
Plaintext

/// \defgroup PkgMesh2Ref Reference Manual
/// \defgroup PkgMesh2Concepts Concepts
/// \ingroup PkgMesh2Ref
/// \defgroup PkgMesh2Functions Mesh Generation Functions
/// \ingroup PkgMesh2Ref
/// The main function to generate a mesh is `refine_Delaunay_mesh_2()`.
/// The function `lloyd_optimize_mesh_2()` allows to optimize an existing mesh.
/// \defgroup PkgMesh2Enum Enumerations
/// \ingroup PkgMesh2Ref
/// \defgroup PkgMesh2IO I/O Functions
/// \ingroup PkgMesh2Ref
/// In addition to the stream extraction and insertion operators for
/// \cgal 2D triangulations, the following functions can be used.
/*!
\addtogroup PkgMesh2Ref
\cgalPkgDescriptionBegin{2D Conforming Triangulations and Meshes,PkgMesh2}
\cgalPkgPicture{Mesh_2/fig/delaunaymesh-small.png}
\cgalPkgSummaryBegin
\cgalPkgAuthor{Laurent Rineau}
\cgalPkgDesc{This package implements a Delaunay refinement algorithm to construct conforming triangulations and 2D meshes.
Conforming Delaunay triangulations are obtained from constrained Delaunay triangulations by refining constrained edges until they are Delaunay edges.
Conforming Gabriel triangulations are obtained by further refining constrained edges until they become Gabriel edges.
The package provides also a 2D mesh generator that refines triangles and constrained edges until user defined size and shape criteria on triangles are satisfied.
The generated meshes can be optimized using the Lloyd algorithm, also provided in this package.
The package can handle intersecting input constraints and set no restriction on the angle formed by two constraints sharing an endpoint.}
\cgalPkgManuals{Chapter_2D_Conforming_Triangulations_and_Meshes,PkgMesh2Ref}
\cgalPkgSummaryEnd
\cgalPkgShortInfoBegin
\cgalPkgSince{3.1}
\cgalPkgDependsOn{\ref PkgTriangulation2}
\cgalPkgBib{cgal:r-ctm2}
\cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgDemo{2D Mesh Generator,constrained_delaunay_triangulation_2.zip}
\cgalPkgShortInfoEnd
\cgalPkgDescriptionEnd
\cgalClassifedRefPages
\cgalCRPSection{Concepts}
- `ConformingDelaunayTriangulationTraits_2`
- `DelaunayMeshTraits_2`
- `MeshingCriteria_2`
- `DelaunayMeshFaceBase_2`
- `DelaunayMeshVertexBase_2`
\cgalCRPSection{Classes}
- `CGAL::Triangulation_conformer_2<CDT>`
- `CGAL::Delaunay_mesher_2<CDT, Criteria>`
- `CGAL::Delaunay_mesh_face_base_2<Traits, Fb>`
- `CGAL::Delaunay_mesh_vertex_base_2<Traits, Vb>`
- `CGAL::Delaunay_mesh_criteria_2<CDT>`
- `CGAL::Delaunay_mesh_size_criteria_2<CDT>`
- `CGAL::Mesh_2::Face_badness`
\cgalCRPSection{Global Functions}
- `CGAL::make_conforming_Delaunay_2`
- `CGAL::make_conforming_Gabriel_2`
- `CGAL::refine_Delaunay_mesh_2`
- `CGAL::lloyd_optimize_mesh_2`
\cgalCRPSection{I/O Functions}
- `CGAL::IO::write_VTU()`
\cgalCRPSection{Enumerations}
- `CGAL::Mesh_optimization_return_code`
*/