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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201 | /* *****************************************************************
MESQUITE -- The Mesh Quality Improvement Toolkit
Copyright 2004 Sandia Corporation and Argonne National
Laboratory. Under the terms of Contract DE-AC04-94AL85000
with Sandia Corporation, the U.S. Government retains certain
rights in 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
[email protected], [email protected], [email protected],
[email protected], [email protected], [email protected]
***************************************************************** */
/*! \file AveragingQM.hpp
\brief
Header file for the MBMesquite::AveragingQM class
\author Thomas Leurent
\author Michael Brewer
\date 2002-05-01
*/
#ifndef MSQ_AVERAGING_QM_HPP
#define MSQ_AVERAGING_QM_HPP
#include "Mesquite.hpp"
#include "QualityMetric.hpp"
namespace MBMesquite
{
/*! \class AveragingQM
\brief Averaging functionality for use in quality metrics
*/
class MsqMeshEntity;
class PatchData;
class Vector3D;
class Matrix3D;
class MsqError;
class AveragingQM
{
public:
MESQUITE_EXPORT AveragingQM( QualityMetric::AveragingMethod method ) : avgMethod( method ) {}<--- Class 'AveragingQM' has a constructor with 1 argument that is not explicit. [+]Class 'AveragingQM' 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.
virtual ~AveragingQM() {}
/*!Set the averaging method for the quality metric. */
MESQUITE_EXPORT inline void set_averaging_method( QualityMetric::AveragingMethod method )
{
avgMethod = method;
}
MESQUITE_EXPORT inline void set_averaging_method( QualityMetric::AveragingMethod method, MsqError& )
{
set_averaging_method( method );
}
MESQUITE_EXPORT inline QualityMetric::AveragingMethod get_averaging_method() const
{
return avgMethod;
}
//! Return true if the requested averaging scheme is supported
//! for analytical calculation of gradients.
inline bool analytical_average_gradient()
{
return avgMethod <= QualityMetric::LAST_WITH_GRADIENT;
}
//! Return true if the requested averaging scheme is supported
//! for analytical calculation of Hessians.
inline bool analytical_average_hessian()
{
return avgMethod <= QualityMetric::LAST_WITH_HESSIAN;
}
//! average_metrics takes an array of length num_values and averages the
//! contents using averaging method data member avgMethod .
double average_metrics( const double metric_values[], int num_values, MsqError& err );
//! Given a list of metric values, calculate the average metric
//! valude according to the current avgMethod and write into
//! the passed metric_values array the the value weight/count to
//! use when averaging gradient vectors for the metric.
//!\param metric_values : As input, a set of quality metric values
//! to average. As output, the fraction of
//! the corresponding gradient vector that
//! contributes to the average gradient.
//!\param num_metric_values The number of values in the passed array.
double average_metric_and_weights( double metric_values[], int num_metric_values, MsqError& err );
/** \brief Average metric values and gradients for per-corner evaluation
*
*\param element_type The element type
*\param num_corners The number of corners (e.g. pass 4 for a pyramid
* if the metric couldn't be evaluated for the apex)
*\param corner_values An array of metric values, one per element corner
*\param corner_grads The corner gradients, 4 for each corner
*\param vertex_grads Output. Gradient at each vertex.
*\return average metric value for element
*/
double average_corner_gradients( EntityTopology element_type,
uint32_t fixed_vertices,
unsigned num_corners,
double corner_values[],
const Vector3D corner_grads[],
Vector3D vertex_grads[],
MsqError& err );
/** \brief Average metric values, gradients, and Hessian diagonal
* blocks for per-corner evaluation
*
*\param element_type The element type
*\param num_corners The number of corners (e.g. pass 4 for a pyramid
* if the metric couldn't be evaluated for the apex)
*\param corner_values An array of metric values, one per element corner
*\param corner_grads The corner gradients, 4 for each corner
*\param corner_hessians The hessians, 10 for each corner
*\param vertex_grads Output. Gradient at each vertex.
*\param vertex_hessians Output. Hessian diagonal block for each vertex.
*\return average metric value for element
*/
double average_corner_hessian_diagonals( EntityTopology element_type,
uint32_t fixed_vertices,
unsigned num_corners,
const double corner_values[],
const Vector3D corner_grads[],
const Matrix3D corner_hessians[],
Vector3D vertex_grads[],
SymMatrix3D vertex_hessians[],
MsqError& err );
/** \brief Average metric values, gradients, and Hessian diagonal
* blocks for per-corner evaluation
*
*\param element_type The element type
*\param num_corners The number of corners (e.g. pass 4 for a pyramid
* if the metric couldn't be evaluated for the apex)
*\param corner_values An array of metric values, one per element corner
*\param corner_grads The corner gradients, 4 for each corner
*\param corner_hess_diag The diagonal blocks of the Hessian: 4 for each corner.
*\param vertex_grads Output. Gradient at each vertex.
*\param vertex_hessians Output. Hessian diagonal block for each vertex.
*\return average metric value for element
*/
double average_corner_hessian_diagonals( EntityTopology element_type,
uint32_t fixed_vertices,
unsigned num_corners,
const double corner_values[],
const Vector3D corner_grads[],
const SymMatrix3D corner_hess_diag[],
Vector3D vertex_grads[],
SymMatrix3D vertex_hessians[],
MsqError& err );
/** \brief Average metric values, gradients, and Hessians for
* per-corner evaluation
*
*\param element_type The element type
*\param num_corners The number of corners (e.g. pass 4 for a pyramid
* if the metric couldn't be evaluated for the apex)
*\param corner_values An array of metric values, one per element corner
*\param corner_grads The corner gradients, 4 for each corner
*\param corner_hessians The hessians, 10 for each corner
*\param vertex_grads Output. Gradient at each vertex.
*\param vertex_hessians Output. Hessians. Length must be (n*(n+1))/2,
* where n is the number of vertices in the element.
*\return average metric value for element
*/
double average_corner_hessians( EntityTopology element_type,
uint32_t fixed_vertices,
unsigned num_corners,
const double corner_values[],
const Vector3D corner_grads[],
const Matrix3D corner_hessians[],
Vector3D vertex_grads[],
Matrix3D vertex_hessians[],
MsqError& err );
private:
QualityMetric::AveragingMethod avgMethod;
};
} // namespace MBMesquite
#endif // MSQ_AVERAGING_QM_HPP
|