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
91
92
93
94
95
96
97
98
99
100
101
102
103
104 | /* *****************************************************************
MESQUITE -- The Mesh Quality Improvement Toolkit
Copyright 2009 Sandia National Laboratories. Developed at the
University of Wisconsin--Madison under SNL contract number
624796. The U.S. Government and the University of Wisconsin
retain certain rights to this software.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
(lgpl.txt) along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
(2009) [email protected]
***************************************************************** */
/** \file NumericalQM.hpp
* \brief
* \author Jason Kraftcheck
*/
#ifndef MSQ_NUMERICAL_QM_HPP
#define MSQ_NUMERICAL_QM_HPP
#include "Mesquite.hpp"
#include "QualityMetric.hpp"
namespace MBMesquite
{
/**\brief Use finite difference rather than analytical derivative calculations.
*
* This class acts as a decorator for (wrapper around) an existing
* QualityMetric. It bypasses any code provided by the underlying
* metric for calculation of derivatives, forcing the use of finite
* difference approximation of the derivatives.
*/
class NumericalQM : public QualityMetric
{
public:
/**
*\param real_metric The actual quality metric.
*\param numerical_gradient Use finite difference to calculate first derivatives
*\param numerical_hessian Use finite difference to calculate second derivatives
*/
NumericalQM( QualityMetric* real_metric, bool numerical_gradient = true, bool numerical_hessian = true );<--- Class 'NumericalQM' has a constructor with 1 argument that is not explicit. [+]Class 'NumericalQM' has a constructor with 1 argument that is not explicit. Such constructors should in general be explicit for type safety reasons. Using the explicit keyword in the constructor means some mistakes when using the class can be avoided.
MetricType get_metric_type() const;
std::string get_name() const;
int get_negate_flag() const;
void get_evaluations( PatchData& pd, std::vector< size_t >& handles, bool free_vertices_only, MsqError& err );
bool evaluate( PatchData& pd, size_t handle, double& value, MsqError& err );
bool evaluate_with_indices( PatchData& pd,
size_t handle,
double& value,
std::vector< size_t >& indices,
MsqError& err );
bool evaluate_with_gradient( PatchData& pd,
size_t handle,
double& value,
std::vector< size_t >& indices,
std::vector< Vector3D >& gradient,
MsqError& err );
bool evaluate_with_Hessian_diagonal( PatchData& pd,
size_t handle,
double& value,
std::vector< size_t >& indices,
std::vector< Vector3D >& gradient,
std::vector< SymMatrix3D >& Hessian_diagonal,
MsqError& err );
bool evaluate_with_Hessian( PatchData& pd,
size_t handle,
double& value,
std::vector< size_t >& indices,
std::vector< Vector3D >& gradient,
std::vector< Matrix3D >& Hessian,
MsqError& err );
private:
QualityMetric* realMetric;
bool numericGrad, numericHess;
};
} // namespace MBMesquite
#endif
|