cgal/Mesh_3/doc_tex/Mesh_3_ref/MeshEdgeCriteria_3.tex

67 lines
2.1 KiB
TeX

% +------------------------------------------------------------------------+
% | Reference manual page: MeshEdgeCriteria_3.tex
% +------------------------------------------------------------------------+
% | 28.07.2009 Stephane Tayeb
% | Package: Mesh_3
% |
\RCSdef{\RCSMeshEdgeCriteriaRev}{$Id$}
\RCSdefDate{\RCSMeshEdgeCriteriaDate}{$Date$}
% |
\ccRefPageBegin
%%RefPage: end of header, begin of main body
% +------------------------------------------------------------------------+
\begin{ccRefFunctionObjectConcept}{MeshEdgeCriteria_3}
%% \ccHtmlCrossLink{} %% add further rules for cross referencing links
%% \ccHtmlIndexC[concept]{} %% add further index entries
\ccDefinition
The function object concept \ccRefName\ is designed to drive the process which samples
the 1-dimensional features of the domain.
%Actually, those features are sampled such as
%each edge of the final set of edges fulfills this edge criteria.
It provides an upper bound for the distance between two protecting ball centers
that are consecutive on a 1-feature.
\ccTypes
\ccNestedType{Point_3}{Point type. Must match the \ccc{Point_3} type in
the triangulation type used by the mesh generation function.}
\ccNestedType{Edge}{Type for edges of the triangulation. Must match the
\ccc{Edge} type in the triangulation type used by the mesh generation function.}
\ccNestedType{FT}{Numerical type.}
\ccCreationVariable{edge_criteria} %% choose variable name
\ccOperations
\ccMethod{bool operator()(const Edge& e);}{
Returns \ccc{true} if edge \ccc{e} does not fulfill the criteria.}
\ccMethod{FT sizing_field(const Point_3& p);}{
Returns the value of the sizing field (i.e. the maximum edge length) at point \ccc{p}.}
\ccHasModels
\ccc{Mesh_edge_criteria_3<Tr>}
\ccSeeAlso
\ccRefConceptPage{MeshCellCriteria_3}\\
\ccRefConceptPage{MeshFacetCriteria_3}\\
\ccRefConceptPage{MeshCriteria_3} \\
\ccRefConceptPage{MeshCriteriaWithFeatures_3}\\
\end{ccRefFunctionObjectConcept}
% +------------------------------------------------------------------------+
%%RefPage: end of main body, begin of footer
\ccRefPageEnd
% EOF
% +------------------------------------------------------------------------+