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

Improve doc of Simplicial_vertex_base_3

This commit is contained in:
Mael Rouxel-Labbé 2023-07-19 22:35:56 +02:00
parent e11bbab4f6
commit 4e824edf32
1 changed files with 47 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

100
SMDS_3/include/CGAL/Simplicial_mesh_vertex_base_3.h
View File

@ -29,22 +29,20 @@
#include <CGAL/Has_timestamp.h>
#include <boost/variant.hpp>
#include <tuple>
namespace CGAL {
//Class Simplicial_mesh_vertex_3
//Adds information to Vb about the localization of the vertex in regards
//to the 3D input complex.
//\cgalModels `SimplicialMeshVertexBase_3`
template<class GT,
typename Subdomain_index,
typename Surface_patch_index,
typename Curve_index,
typename Corner_index,
class Vb>
// Adds information to Vb about the localization of the vertex in regards to the 3D input complex.
template<typename Gt,
typename SubdomainIndex,
typename SurfacePatchIndex,
typename CurveIndex,
typename CornerIndex,
typename Vb>
class Simplicial_mesh_vertex_3
: public Vb
: public Vb
{
private :
using Cmvb3_base = Vb;
@ -53,10 +51,16 @@ public:
using Vertex_handle = typename Vb::Vertex_handle;
// Types
using Index = boost::variant<Subdomain_index, Surface_patch_index, Curve_index, Corner_index>;
using FT = typename GT::FT;
using Subdomain_index = SubdomainIndex;
using Surface_patch_index = SurfacePatchIndex;
using Curve_index = CurveIndex;
using Corner_index = CornerIndex;
// Constructor
using Index = boost::variant<Subdomain_index, Surface_patch_index, Curve_index, Corner_index>;
using FT = typename Gt::FT;
public:
Simplicial_mesh_vertex_3()
: Vb()
, number_of_incident_facets_(0)
@ -215,39 +219,34 @@ index of the subcomplex it belongs to.
\tparam Gt is the geometric traits class.
It must be a model of the concept `TriangulationTraits_3`
\tparam Subdomain_index Type of indices for subdomains of the discretized geometric domain.
\tparam SubdomainIndex Type of indices for subdomains of the discretized geometric domain.
Must be a model of `CopyConstructible`, `Assignable`, `DefaultConstructible`
and `EqualityComparable`. The default constructed value must match the label
of the exterior of the domain (which contains at least the unbounded component).
It must match the `Subdomain_index` of the model
of the `MeshDomain_3` concept when used for mesh generation.
It must match `MeshDomain_3::Subdomain_index` when used for mesh generation.
\tparam Surface_patch_index Type of indices for surface patches (boundaries and interfaces)
\tparam SurfacePatchIndex Type of indices for surface patches (boundaries and interfaces)
of the discretized geometric domain.
Must be a model of `CopyConstructible`, `Assignable`, `DefaultConstructible`
and `EqualityComparable`. The default constructed value must be the index value
assigned to a non surface facet.
It must match the `Surface_patch_index` of the model
of the `MeshDomain_3` concept when used for mesh generation.
It must match `MeshDomain_3::Surface_patch_index` when used for mesh generation.
\tparam Curve_index Type of indices for curves (i.e. \f$ 1\f$-dimensional features)
\tparam CurveIndex Type of indices for curves (i.e. \f$ 1\f$-dimensional features)
of the discretized geometric domain.
Must be a model of `CopyConstructible`, `Assignable`, `DefaultConstructible` and
`LessThanComparable`. The default constructed value must be the value for an edge which
does not approximate a 1-dimensional feature of the geometric domain.
It must match the `Curve_index` types of the model
of the `MeshDomainWithFeatures_3` concept when used for mesh generation.
It must match `MeshDomainWithFeatures_3::Curve_index` when used for mesh generation.
\tparam Corner_index Type of indices for corners (i.e.\f$ 0\f$--dimensional features)
\tparam CornerIndex Type of indices for corners (i.e.\f$ 0\f$--dimensional features)
of the discretized geometric domain.
It must be a model of `CopyConstructible`, `Assignable`, `DefaultConstructible` and
`LessThanComparable`.
It must match the `Corner_index` of the model
of the `MeshDomainWithFeatures_3` concept when used for mesh generation.
It must match `MeshDomainWithFeatures_3::Corner_index` when used for mesh generation.
\tparam Vb is the vertex base class. It has to be a model
of the concept `TriangulationVertexBase_3` and defaults to
`Triangulation_vertex_base_3<Gt>`.
\tparam Vb is the vertex base class from which `Simplicial_mesh_vertex_base_3` derives.
It must be a model of the concept `TriangulationVertexBase_3`.
\cgalModels `SimplicialMeshVertexBase_3`
@ -256,33 +255,28 @@ of the concept `TriangulationVertexBase_3` and defaults to
\sa `MeshDomain_3`
\sa `MeshDomainWithFeatures_3`
*/
template<class Gt,
typename Subdomain_index,
typename Surface_patch_index,
typename Curve_index,
typename Corner_index,
class Vb = Triangulation_vertex_base_3<Gt> >
struct Simplicial_mesh_vertex_base_3
template<typename Gt,
typename SubdomainIndex,
typename SurfacePatchIndex,
typename CurveIndex,
typename CornerIndex,
typename Vb = CGAL::Triangulation_vertex_base_3<Gt> >
class Simplicial_mesh_vertex_base_3
{
using Triangulation_data_structure = internal::Dummy_tds_3;
using Vertex_handle = typename Triangulation_data_structure::Vertex_handle;
using Cell_handle = typename Triangulation_data_structure::Cell_handle;
template < class TDS3 >
struct Rebind_TDS {
using Vb3 = typename Vb::template Rebind_TDS<TDS3>::Other;
using Other = Simplicial_mesh_vertex_3 <Gt,
Subdomain_index,
Surface_patch_index,
Curve_index,
Corner_index,
Vb3>;
public:
template <typename TDS2>
struct Rebind_TDS
{
using Vb2 = typename Vb::template Rebind_TDS<TDS2>::Other;
using Other = Simplicial_mesh_vertex_3<Gt,
SubdomainIndex,
SurfacePatchIndex,
CurveIndex,
CornerIndex,
Vb2>;
};
};
} // end namespace CGAL
} // namespace CGAL
#endif // CGAL_SIMPLICIAL_MESH_VERTEX_BASE_3_H