1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
|
// Copyright (c) 2022-2024 INRIA Sophia-Antipolis (France), GeometryFactory (France).
// All rights reserved.
//
// This file is part of CGAL (www.cgal.org).
//
// $URL: https://github.com/CGAL/cgal/blob/v6.1.1/Isosurfacing_3/include/CGAL/Isosurfacing_3/Gradient_function_3.h $
// $Id: include/CGAL/Isosurfacing_3/Gradient_function_3.h 08b27d3db14 $
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-Commercial
//
// Author(s) : Julian Stahl
// Mael Rouxel-Labbé
#ifndef CGAL_ISOSURFACING_3_GRADIENT_FUNCTION_3_H
#define CGAL_ISOSURFACING_3_GRADIENT_FUNCTION_3_H
#include <CGAL/license/Isosurfacing_3.h>
#include <CGAL/Isosurfacing_3/internal/partition_traits.h>
#include <functional>
namespace CGAL {
namespace Isosurfacing {
/**
* \ingroup IS_Fields_grp
*
* \cgalModels{IsosurfacingGradientField_3}
*
* \brief The class `Gradient_function_3` represents a field of vectors computed
* using a user-provided unary function.
*
* \tparam Partition must be a model of `IsosurfacingPartition_3`
*
* \sa `CGAL::Isosurfacing::Dual_contouring_domain_3`
*/
template <typename Partition>
class Gradient_function_3
{
public:
using Geom_traits = typename Partition::Geom_traits;
using Point_3 = typename Geom_traits::Point_3;
using Vector_3 = typename Geom_traits::Vector_3;
using PT = partition_traits<Partition>;
using vertex_descriptor = typename PT::vertex_descriptor;
private:
std::function<Vector_3(const Point_3&)> m_fn;
const Partition& m_partition;
public:
/**
* \brief constructs a field of gradients using a gradient function and a partition.
*
* \tparam Function must provide the following function signature:
* `Vector_3 operator()(const %Point_3&) const`
*
* \param fn the function providing gradients
* \param partition the space partitioning data structure
*/
template <typename Function>
Gradient_function_3(const Function& fn,
const Partition& partition)
: m_fn{fn},
m_partition{partition}
{ }
public:
/**
* \brief returns the value of the function at the point `p`.
*/
Vector_3 operator()(const Point_3& p) const
{
return m_fn(p);
}
/**
* \brief returns the value of the function at the vertex `v`.
*/
const Vector_3& operator()(const vertex_descriptor& v) const
{
return this->operator()(PT::point(v, m_partition));
}
};
} // namespace Isosurfacing
} // namespace CGAL
#endif // CGAL_ISOSURFACING_3_GRADIENT_FUNCTION_3_H
|
