add named parameters and doc

This commit is contained in:
Jane Tournois 2022-12-05 15:56:56 +01:00
parent 9fd54baee2
commit 07fb42117c
2 changed files with 17 additions and 2 deletions

View File

@ -79,13 +79,13 @@ public:
parameters::choose_parameter(parameters::get_parameter(np, internal_np::sizing_field_param), FT(0)))),
parameters::choose_parameter(parameters::get_parameter_reference(np, internal_np::facet_distance_param), FT(0)),
parameters::choose_parameter(parameters::get_parameter(np, internal_np::facet_topology_param), CGAL::FACET_VERTICES_ON_SURFACE),
parameters::choose_parameter(parameters::get_parameter(np, internal_np::facet_minimal_size), FT(0))),
parameters::choose_parameter(parameters::get_parameter(np, internal_np::facet_min_size_param), FT(0))),
cell_criteria_(parameters::choose_parameter(parameters::get_parameter(np, internal_np::cell_radius_edge_ratio_param),
parameters::choose_parameter(parameters::get_parameter(np, internal_np::cell_radius_edge_param), FT(0))),
parameters::choose_parameter(parameters::get_parameter(np, internal_np::cell_size_param),
parameters::choose_parameter(parameters::get_parameter_reference(np, internal_np::cell_sizing_field_param),
parameters::choose_parameter(parameters::get_parameter_reference(np, internal_np::sizing_field_param), FT(0)))),
parameters::choose_parameter(parameters::get_parameter(np, internal_np::cell_minimal_size), FT(0)))
parameters::choose_parameter(parameters::get_parameter(np, internal_np::cell_min_size_param), FT(0)))
{ }
#ifndef CGAL_NO_DEPRECATED_CODE
@ -263,6 +263,12 @@ typedef Mesh_cell_criteria_3<Tr> Cell_criteria;
* \cgalParamDescription{a scalar field (resp. a constant) describing
* a space varying (resp. a uniform) upper-bound or for the radii of the surface Delaunay balls.}
* \cgalParamNEnd
* \cgalParamNBegin{facet_min_size}
* \cgalParamDescription{a constant describing a uniform upper-bound for the radii of the surface Delaunay balls.
* Only facets with a radius larger than this bound will be refined.
* If a facet is too small with respect to this criterion,
* it will not be refined however the other criteria are met or not.}
* \cgalParamNEnd
* \cgalParamNBegin{facet_distance}
* \cgalParamDescription{a scalar field (resp. a constant) describing a space varying (resp. a uniform)
* upper bound for the distance between the facet circumcenter and the center of its surface
@ -281,6 +287,13 @@ typedef Mesh_cell_criteria_3<Tr> Cell_criteria;
* \cgalParamDescription{ a scalar field (resp. a constant) describing
* a space varying (resp. a uniform) upper-bound for the circumradii of the mesh tetrahedra.}
* \cgalParamNEnd
* \cgalParamNBegin{cell_min_size}
* \cgalParamDescription{ a constant describing a uniform upper-bound for the radii of the circumradii
* of the mesh tetrahedra.
* Only tetrahedra with a circumradius larger than this bound will be refined.
* If a cell is too small with respect to this criterion,
* it will not be refined however the other criteria are met or not.}
* \cgalParamNEnd
* \cgalNamedParamsEnd
*/
template<typename CGAL_NP_TEMPLATE_PARAMETERS>

View File

@ -316,12 +316,14 @@ CGAL_add_named_parameter_with_compatibility(edge_size_param_t, edge_size_param,
CGAL_add_named_parameter_with_compatibility_ref_only(edge_sizing_field_param_t, edge_sizing_field_param, edge_sizing_field)
CGAL_add_named_parameter_with_compatibility(facet_angle_param_t, facet_angle_param, facet_angle)
CGAL_add_named_parameter_with_compatibility(facet_size_param_t, facet_size_param, facet_size)
CGAL_add_named_parameter_with_compatibility(facet_min_size_param_t, facet_min_size_param, facet_min_size)
CGAL_add_named_parameter_with_compatibility_ref_only(facet_sizing_field_param_t, facet_sizing_field_param, facet_sizing_field)
CGAL_add_named_parameter_with_compatibility_ref_only(facet_distance_param_t, facet_distance_param, facet_distance)
CGAL_add_named_parameter_with_compatibility(facet_topology_param_t, facet_topology_param, facet_topology)
CGAL_add_named_parameter_with_compatibility(cell_radius_edge_param_t, cell_radius_edge_param, cell_radius_edge)
CGAL_add_named_parameter_with_compatibility(cell_radius_edge_ratio_param_t, cell_radius_edge_ratio_param, cell_radius_edge_ratio)
CGAL_add_named_parameter_with_compatibility(cell_size_param_t, cell_size_param, cell_size)
CGAL_add_named_parameter_with_compatibility(cell_min_size_param_t, cell_min_size_param, cell_min_size)
CGAL_add_named_parameter_with_compatibility_ref_only(cell_sizing_field_param_t, cell_sizing_field_param, cell_sizing_field)
CGAL_add_named_parameter_with_compatibility_ref_only(sizing_field_param_t, sizing_field_param, sizing_field)