EdgeLengthRangeQualityMetric Class Reference

Computes the edge length range metric for a given vertex. More...

#include <EdgeLengthRangeQualityMetric.hpp>

Inheritance diagram for EdgeLengthRangeQualityMetric:

Collaboration diagram for EdgeLengthRangeQualityMetric:

Public Member Functions
	EdgeLengthRangeQualityMetric (double low_a, double high_a, MsqError &err)
virtual	~EdgeLengthRangeQualityMetric ()
	EdgeLengthRangeQualityMetric (double low_a, double high_a, MsqError &err)
virtual	~EdgeLengthRangeQualityMetric ()
Public Member Functions inherited from SmoothnessQualityMetric
virtual	~SmoothnessQualityMetric ()
virtual	~SmoothnessQualityMetric ()
Public Member Functions inherited from QualityMetric
virtual	~QualityMetric ()
MetricType	get_metric_type ()
void	set_element_evaluation_mode (ElementEvaluationMode mode, MsqError &err)
	Sets the evaluation mode for the ELEMENT_BASED metrics. More...
ElementEvaluationMode	get_element_evaluation_mode ()
	Returns the evaluation mode for the metric. More...
void	set_averaging_method (AveragingMethod method, MsqError &err)
void	set_feasible_constraint (int alpha)
int	get_feasible_constraint ()
	Returns the feasible flag for this metric. More...
void	set_name (msq_std::string st)
	Sets the name of this metric. More...
msq_std::string	get_name ()
	Returns the name of this metric (as a string). More...
double	vertex_barrier_function (double det, double delta)
	Escobar Barrier Function for Shape and Other Metrics. More...
virtual bool	evaluate_element (PatchData &, MsqMeshEntity *, double &, MsqError &err)
	Evaluate the metric for an element. More...
void	set_gradient_type (GRADIENT_TYPE grad)
	Sets gradType for this metric. More...
void	set_hessian_type (HESSIAN_TYPE ht)
	Sets hessianType for this metric. More...
bool	compute_vertex_gradient (PatchData &pd, MsqVertex &vertex, MsqVertex *vertices[], Vector3D grad_vec[], int num_vtx, double &metric_value, MsqError &err)
	Calls compute_vertex_numerical_gradient if gradType equals NUMERCIAL_GRADIENT. Calls compute_vertex_analytical_gradient if gradType equals ANALYTICAL_GRADIENT;. More...
bool	compute_element_gradient (PatchData &pd, MsqMeshEntity *element, MsqVertex *free_vtces[], Vector3D grad_vec[], int num_free_vtx, double &metric_value, MsqError &err)
	For MetricType == ELEMENT_BASED. Calls either compute_element_numerical_gradient() or compute_element_analytical_gradient() for gradType equal NUMERICAL_GRADIENT or ANALYTICAL_GRADIENT, respectively. More...
bool	compute_element_gradient_expanded (PatchData &pd, MsqMeshEntity *element, MsqVertex *free_vtces[], Vector3D grad_vec[], int num_free_vtx, double &metric_value, MsqError &err)
bool	compute_element_hessian (PatchData &pd, MsqMeshEntity *element, MsqVertex *free_vtces[], Vector3D grad_vec[], Matrix3D hessian[], int num_free_vtx, double &metric_value, MsqError &err)
	For MetricType == ELEMENT_BASED. Calls either compute_element_numerical_hessian() or compute_element_analytical_hessian() for hessianType equal NUMERICAL_HESSIAN or ANALYTICAL_HESSIAN, respectively. More...
void	set_negate_flag (int neg)
int	get_negate_flag ()
	Returns negateFlag. More...
virtual void	change_metric_type (MetricType t, MsqError &err)
virtual	~QualityMetric ()
MetricType	get_metric_type ()
void	set_element_evaluation_mode (ElementEvaluationMode mode, MsqError &err)
	Sets the evaluation mode for the ELEMENT_BASED metrics. More...
ElementEvaluationMode	get_element_evaluation_mode ()
	Returns the evaluation mode for the metric. More...
void	set_averaging_method (AveragingMethod method, MsqError &err)
void	set_feasible_constraint (int alpha)
int	get_feasible_constraint ()
	Returns the feasible flag for this metric. More...
void	set_name (msq_std::string st)
	Sets the name of this metric. More...
msq_std::string	get_name ()
	Returns the name of this metric (as a string). More...
double	vertex_barrier_function (double det, double delta)
	Escobar Barrier Function for Shape and Other Metrics. More...
virtual bool	evaluate_element (PatchData &, MsqMeshEntity *, double &, MsqError &err)
	Evaluate the metric for an element. More...
void	set_gradient_type (GRADIENT_TYPE grad)
	Sets gradType for this metric. More...
void	set_hessian_type (HESSIAN_TYPE ht)
	Sets hessianType for this metric. More...
bool	compute_vertex_gradient (PatchData &pd, MsqVertex &vertex, MsqVertex *vertices[], Vector3D grad_vec[], int num_vtx, double &metric_value, MsqError &err)
bool	compute_element_gradient (PatchData &pd, MsqMeshEntity *element, MsqVertex *free_vtces[], Vector3D grad_vec[], int num_free_vtx, double &metric_value, MsqError &err)
	For MetricType == ELEMENT_BASED. Calls either compute_element_numerical_gradient() or compute_element_analytical_gradient() for gradType equal NUMERICAL_GRADIENT or ANALYTICAL_GRADIENT, respectively. More...
bool	compute_element_gradient_expanded (PatchData &pd, MsqMeshEntity *element, MsqVertex *free_vtces[], Vector3D grad_vec[], int num_free_vtx, double &metric_value, MsqError &err)
bool	compute_element_hessian (PatchData &pd, MsqMeshEntity *element, MsqVertex *free_vtces[], Vector3D grad_vec[], Matrix3D hessian[], int num_free_vtx, double &metric_value, MsqError &err)
	For MetricType == ELEMENT_BASED. Calls either compute_element_numerical_hessian() or compute_element_analytical_hessian() for hessianType equal NUMERICAL_HESSIAN or ANALYTICAL_HESSIAN, respectively. More...
void	set_negate_flag (int neg)
int	get_negate_flag ()
	Returns negateFlag. More...
virtual void	change_metric_type (MetricType t, MsqError &err)

Protected Member Functions
bool	evaluate_vertex (PatchData &pd, MsqVertex *vert, double &fval, MsqError &err)
bool	evaluate_vertex (PatchData &pd, MsqVertex *vert, double &fval, MsqError &err)
	Evaluate the metric for a vertex. More...
Protected Member Functions inherited from SmoothnessQualityMetric
void	compute_scalar_weights (int num_scalar_weights, double scalar_weights[], MsqError &err)
void	compute_scalar_weights (int num_scalar_weights, double scalar_weights[], MsqError &err)
Protected Member Functions inherited from QualityMetric
	QualityMetric ()
void	set_metric_type (MetricType t)
	This function should be used in the constructor of every concrete quality metric. More...
double	average_metrics (const double metric_values[], const int &num_values, MsqError &err)
	average_metrics takes an array of length num_values and averages the contents using averaging method data member avgMethod . More...
double	average_metric_and_weights (double metric_values[], int num_metric_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. More...
double	weighted_average_metrics (const double coef[], const double metric_values[], const int &num_values, MsqError &err)
	takes an array of coefficients and an array of metrics (both of length num_value) and averages the contents using averaging method 'method'. More...
bool	compute_vertex_numerical_gradient (PatchData &pd, MsqVertex &vertex, MsqVertex *vertices[], Vector3D grad_vec[], int num_vtx, double &metric_value, MsqError &err)
bool	compute_element_numerical_gradient (PatchData &pd, MsqMeshEntity *element, MsqVertex *free_vtces[], Vector3D grad_vec[], int num_free_vtx, double &metric_value, MsqError &err)
	Non-virtual function which numerically computes the gradient of a QualityMetric of a given element for a given set of free vertices on that element. This is used by metric which mType is ELEMENT_BASED. For parameters, see compute_element_gradient() . More...
virtual bool	compute_vertex_analytical_gradient (PatchData &pd, MsqVertex &vertex, MsqVertex *vertices[], Vector3D grad_vec[], int num_vtx, double &metric_value, MsqError &err)
	Virtual function that computes the gradient of the QualityMetric analytically. The base class implementation of this function simply prints a warning and calls compute_numerical_gradient to calculate the gradient. This is used by metric which mType is VERTEX_BASED. More...
virtual bool	compute_element_analytical_gradient (PatchData &pd, MsqMeshEntity *element, MsqVertex *free_vtces[], Vector3D grad_vec[], int num_free_vtx, double &metric_value, MsqError &err)
	Virtual function that computes the gradient of the QualityMetric analytically. The base class implementation of this function simply prints a warning and calls compute_numerical_gradient to calculate the gradient. This is used by metric which mType is ELEMENT_BASED. For parameters, see compute_element_gradient() . More...
bool	compute_element_numerical_hessian (PatchData &pd, MsqMeshEntity *element, MsqVertex *free_vtces[], Vector3D grad_vec[], Matrix3D hessian[], int num_free_vtx, double &metric_value, MsqError &err)
virtual bool	compute_element_analytical_hessian (PatchData &pd, MsqMeshEntity *element, MsqVertex *free_vtces[], Vector3D grad_vec[], Matrix3D hessian[], int num_free_vtx, double &metric_value, MsqError &err)
	QualityMetric ()
void	set_metric_type (MetricType t)
	This function should be used in the constructor of every concrete quality metric. More...
double	average_metrics (const double metric_values[], const int &num_values, MsqError &err)
	average_metrics takes an array of length num_values and averages the contents using averaging method data member avgMethod . More...
double	average_metric_and_weights (double metric_values[], int num_metric_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. More...
double	weighted_average_metrics (const double coef[], const double metric_values[], const int &num_values, MsqError &err)
	takes an array of coefficients and an array of metrics (both of length num_value) and averages the contents using averaging method 'method'. More...
bool	compute_vertex_numerical_gradient (PatchData &pd, MsqVertex &vertex, MsqVertex *vertices[], Vector3D grad_vec[], int num_vtx, double &metric_value, MsqError &err)
bool	compute_element_numerical_gradient (PatchData &pd, MsqMeshEntity *element, MsqVertex *free_vtces[], Vector3D grad_vec[], int num_free_vtx, double &metric_value, MsqError &err)
	Non-virtual function which numerically computes the gradient of a QualityMetric of a given element for a given set of free vertices on that element. This is used by metric which mType is ELEMENT_BASED. For parameters, see compute_element_gradient() . More...
virtual bool	compute_vertex_analytical_gradient (PatchData &pd, MsqVertex &vertex, MsqVertex *vertices[], Vector3D grad_vec[], int num_vtx, double &metric_value, MsqError &err)
	Virtual function that computes the gradient of the QualityMetric analytically. The base class implementation of this function simply prints a warning and calls compute_numerical_gradient to calculate the gradient. This is used by metric which mType is VERTEX_BASED. More...
virtual bool	compute_element_analytical_gradient (PatchData &pd, MsqMeshEntity *element, MsqVertex *free_vtces[], Vector3D grad_vec[], int num_free_vtx, double &metric_value, MsqError &err)
	Virtual function that computes the gradient of the QualityMetric analytically. The base class implementation of this function simply prints a warning and calls compute_numerical_gradient to calculate the gradient. This is used by metric which mType is ELEMENT_BASED. For parameters, see compute_element_gradient() . More...
bool	compute_element_numerical_hessian (PatchData &pd, MsqMeshEntity *element, MsqVertex *free_vtces[], Vector3D grad_vec[], Matrix3D hessian[], int num_free_vtx, double &metric_value, MsqError &err)
virtual bool	compute_element_analytical_hessian (PatchData &pd, MsqMeshEntity *element, MsqVertex *free_vtces[], Vector3D grad_vec[], Matrix3D hessian[], int num_free_vtx, double &metric_value, MsqError &err)

Private Member Functions
	EdgeLengthRangeQualityMetric ()
	EdgeLengthRangeQualityMetric ()

Private Attributes
double	highVal
double	lowVal

Additional Inherited Members
Public Types inherited from QualityMetric
enum	MetricType {   MT_UNDEFINED, VERTEX_BASED, ELEMENT_BASED, VERTEX_BASED_FREE_ONLY,   MT_UNDEFINED, VERTEX_BASED, ELEMENT_BASED, VERTEX_BASED_FREE_ONLY }
enum	ElementEvaluationMode {   EEM_UNDEFINED, ELEMENT_VERTICES, LINEAR_GAUSS_POINTS, QUADRATIC_GAUSS_POINTS,   CUBIC_GAUSS_POINTS, EEM_UNDEFINED, ELEMENT_VERTICES, LINEAR_GAUSS_POINTS,   QUADRATIC_GAUSS_POINTS, CUBIC_GAUSS_POINTS }
enum	AveragingMethod {   NONE, LINEAR, RMS, HMS,   MINIMUM, MAXIMUM, HARMONIC, GEOMETRIC,   SUM, SUM_SQUARED, GENERALIZED_MEAN, STANDARD_DEVIATION,   MAX_OVER_MIN, MAX_MINUS_MIN, SUM_OF_RATIOS_SQUARED, NONE,   LINEAR, RMS, HMS, MINIMUM,   MAXIMUM, HARMONIC, GEOMETRIC, SUM,   SUM_SQUARED, GENERALIZED_MEAN, STANDARD_DEVIATION, MAX_OVER_MIN,   MAX_MINUS_MIN, SUM_OF_RATIOS_SQUARED }
enum	GRADIENT_TYPE { NUMERICAL_GRADIENT, ANALYTICAL_GRADIENT, NUMERICAL_GRADIENT, ANALYTICAL_GRADIENT }
enum	HESSIAN_TYPE { NUMERICAL_HESSIAN, ANALYTICAL_HESSIAN, NUMERICAL_HESSIAN, ANALYTICAL_HESSIAN }
enum	MetricType {   MT_UNDEFINED, VERTEX_BASED, ELEMENT_BASED, VERTEX_BASED_FREE_ONLY,   MT_UNDEFINED, VERTEX_BASED, ELEMENT_BASED, VERTEX_BASED_FREE_ONLY }
enum	ElementEvaluationMode {   EEM_UNDEFINED, ELEMENT_VERTICES, LINEAR_GAUSS_POINTS, QUADRATIC_GAUSS_POINTS,   CUBIC_GAUSS_POINTS, EEM_UNDEFINED, ELEMENT_VERTICES, LINEAR_GAUSS_POINTS,   QUADRATIC_GAUSS_POINTS, CUBIC_GAUSS_POINTS }
enum	AveragingMethod {   NONE, LINEAR, RMS, HMS,   MINIMUM, MAXIMUM, HARMONIC, GEOMETRIC,   SUM, SUM_SQUARED, GENERALIZED_MEAN, STANDARD_DEVIATION,   MAX_OVER_MIN, MAX_MINUS_MIN, SUM_OF_RATIOS_SQUARED, NONE,   LINEAR, RMS, HMS, MINIMUM,   MAXIMUM, HARMONIC, GEOMETRIC, SUM,   SUM_SQUARED, GENERALIZED_MEAN, STANDARD_DEVIATION, MAX_OVER_MIN,   MAX_MINUS_MIN, SUM_OF_RATIOS_SQUARED }
enum	GRADIENT_TYPE { NUMERICAL_GRADIENT, ANALYTICAL_GRADIENT, NUMERICAL_GRADIENT, ANALYTICAL_GRADIENT }
enum	HESSIAN_TYPE { NUMERICAL_HESSIAN, ANALYTICAL_HESSIAN, NUMERICAL_HESSIAN, ANALYTICAL_HESSIAN }
Protected Attributes inherited from QualityMetric
AveragingMethod	avgMethod
int	feasible
msq_std::string	metricName

Detailed Description

Computes the edge length range metric for a given vertex.

EdgeLengthRangeQualityMetric is a vertex based metric which computes the lengths of the edges connected to a given vertex and then uses those values to form a metric. The metric is created using two doubles A and B. The value of the metric is zero (ideal) if the edge lengths are in the range [A,B]. Otherwise, the metric value is some positive number. For a given vertex, v_i, with connected edges of lengths l_j for j=1...k, the metric value is the average (where the default average type is SUM) of u_j = ( | l_j - A | - (l_j - A) )^2 + ( | B - l_j | - (B - l_j) )^2.

Definition at line 63 of file includeLinks/EdgeLengthRangeQualityMetric.hpp.

Constructor & Destructor Documentation

EdgeLengthRangeQualityMetric ( double  low_a, double  high_a, MsqError &  err  )

inline

Definition at line 68 of file includeLinks/EdgeLengthRangeQualityMetric.hpp.

References QualityMetric::avgMethod, QualityMetric::feasible, EdgeLengthRangeQualityMetric::highVal, MsqError::INVALID_ARG, EdgeLengthRangeQualityMetric::lowVal, MSQ_SETERR, QualityMetric::set_metric_type(), QualityMetric::set_name(), QualityMetric::SUM, and QualityMetric::VERTEX_BASED.

       {
         if(low_a>high_a){
           MSQ_SETERR(err)("Edge Length Range values given in descending order.",
                           MsqError::INVALID_ARG);
         }
         lowVal=low_a;
         highVal=high_a;
         avgMethod=SUM;
         feasible=0;
         set_metric_type(QualityMetric::VERTEX_BASED);
         set_name("Edge Length Range Metric");
       }

Here is the call graph for this function:

virtual ~EdgeLengthRangeQualityMetric ( )

inlinevirtual

Definition at line 83 of file includeLinks/EdgeLengthRangeQualityMetric.hpp.

       {}

EdgeLengthRangeQualityMetric ( )

inlineprivate

Definition at line 95 of file includeLinks/EdgeLengthRangeQualityMetric.hpp.

References QualityMetric::avgMethod, QualityMetric::feasible, EdgeLengthRangeQualityMetric::highVal, EdgeLengthRangeQualityMetric::lowVal, QualityMetric::set_metric_type(), QualityMetric::set_name(), QualityMetric::SUM, and QualityMetric::VERTEX_BASED.

       {
         lowVal=0;
         highVal=0;
         avgMethod=SUM;
         feasible=0;
         set_metric_type(QualityMetric::VERTEX_BASED);
         set_name("Edge Length Range Metric Default Constructor");
       }

Here is the call graph for this function:

EdgeLengthRangeQualityMetric ( double  low_a, double  high_a, MsqError &  err  )

inline

Definition at line 68 of file src/QualityMetric/Smoothness/EdgeLengthRangeQualityMetric.hpp.

References QualityMetric::avgMethod, QualityMetric::feasible, EdgeLengthRangeQualityMetric::highVal, MsqError::INVALID_ARG, EdgeLengthRangeQualityMetric::lowVal, MSQ_SETERR, QualityMetric::set_metric_type(), QualityMetric::set_name(), QualityMetric::SUM, and QualityMetric::VERTEX_BASED.

       {
         if(low_a>high_a){
           MSQ_SETERR(err)("Edge Length Range values given in descending order.",
                           MsqError::INVALID_ARG);
         }
         lowVal=low_a;
         highVal=high_a;
         avgMethod=SUM;
         feasible=0;
         set_metric_type(QualityMetric::VERTEX_BASED);
         set_name("Edge Length Range Metric");
       }

Here is the call graph for this function:

virtual ~EdgeLengthRangeQualityMetric ( )

inlinevirtual

Definition at line 83 of file src/QualityMetric/Smoothness/EdgeLengthRangeQualityMetric.hpp.

       {}

EdgeLengthRangeQualityMetric ( )

inlineprivate

Definition at line 95 of file src/QualityMetric/Smoothness/EdgeLengthRangeQualityMetric.hpp.

References QualityMetric::avgMethod, QualityMetric::feasible, EdgeLengthRangeQualityMetric::highVal, EdgeLengthRangeQualityMetric::lowVal, QualityMetric::set_metric_type(), QualityMetric::set_name(), QualityMetric::SUM, and QualityMetric::VERTEX_BASED.

       {
         lowVal=0;
         highVal=0;
         avgMethod=SUM;
         feasible=0;
         set_metric_type(QualityMetric::VERTEX_BASED);
         set_name("Edge Length Range Metric Default Constructor");
       }

Here is the call graph for this function:

Member Function Documentation

bool evaluate_vertex ( PatchData &  pd, MsqVertex *  vert, double &  fval, MsqError &  err  )

protectedvirtual

For the given vertex, vert, with connected edges of lengths l_j for j=1...k, the metric value is the average (where the default average type is SUM) of u_j = ( | l_j - lowVal | - (l_j - lowVal) )^2 + ( | highVal - l_j | - (highVal - l_j) )^2.

Reimplemented from QualityMetric.

Definition at line 59 of file QualityMetric/Smoothness/EdgeLengthRangeQualityMetric.cpp.

References QualityMetric::average_metrics(), PatchData::get_adjacent_vertex_indices(), PatchData::get_vertex_array(), PatchData::get_vertex_index(), EdgeLengthRangeQualityMetric::highVal, Vector3D::length(), EdgeLengthRangeQualityMetric::lowVal, and MSQ_ERRZERO.

{
  fval=0.0;
  size_t this_vert = pd.get_vertex_index(vert);
  size_t other_vert;
  vector<size_t> adj_verts;
  Vector3D edg;
  pd.get_adjacent_vertex_indices(this_vert,adj_verts,err);  MSQ_ERRZERO(err);
  int num_sample_points=adj_verts.size();
  double *metric_values=new double[num_sample_points];
  MsqVertex* verts = pd.get_vertex_array(err);  MSQ_ERRZERO(err);
  int point_counter=0;
    //store the length of the edge, and the first and second component of
    //metric values, respectively.
  double temp_length=0.0;
  double temp_first=0.0;
  double temp_second=0.0;
    //PRINT_INFO("INSIDE ELR, vertex = %f,%f,%f\n",verts[this_vert][0],verts[this_vert][1],verts[this_vert][2]);
    //loop while there are still more adjacent vertices.
  while(!adj_verts.empty()){
    other_vert=adj_verts.back();
    adj_verts.pop_back();
    edg[0]=verts[this_vert][0]-verts[other_vert][0];
    edg[1]=verts[this_vert][1]-verts[other_vert][1];
    edg[2]=verts[this_vert][2]-verts[other_vert][2];
      //compute the edge length
    temp_length=edg.length();
      //get the first component
    temp_first = temp_length - lowVal;
    temp_first = fabs(temp_first) - (temp_first);
    temp_first*=temp_first;
      //get the second component
    temp_second = highVal - temp_length;
    temp_second = fabs(temp_second) - (temp_second);
    temp_second*=temp_second;
      //combine the two components
    metric_values[point_counter]=temp_first+temp_second;
      //increment the counter
    ++point_counter;
  }
    //average the metric values of the edges
  fval=average_metrics(metric_values,num_sample_points,err);  MSQ_ERRZERO(err);
    //clean up
  delete[] metric_values;
    //always return true because mesh is always valid wrt this metric.
  return true;
  
}

Here is the call graph for this function:

bool evaluate_vertex ( PatchData &  , MsqVertex *  , double &  , MsqError &  err  )

protectedvirtual

Evaluate the metric for a vertex.

Reimplemented from QualityMetric.

Member Data Documentation

double highVal

private

Definition at line 105 of file includeLinks/EdgeLengthRangeQualityMetric.hpp.

Referenced by EdgeLengthRangeQualityMetric::EdgeLengthRangeQualityMetric(), and EdgeLengthRangeQualityMetric::evaluate_vertex().

double lowVal

private

Definition at line 106 of file includeLinks/EdgeLengthRangeQualityMetric.hpp.

Referenced by EdgeLengthRangeQualityMetric::EdgeLengthRangeQualityMetric(), and EdgeLengthRangeQualityMetric::evaluate_vertex().

---

The documentation for this class was generated from the following files:

• includeLinks/EdgeLengthRangeQualityMetric.hpp
• src/QualityMetric/Smoothness/EdgeLengthRangeQualityMetric.hpp
• QualityMetric/Smoothness/EdgeLengthRangeQualityMetric.cpp
• inks/EdgeLengthRangeQualityMetric.cpp