Class containing the target corner matrices for the context based smoothing. More...

#include <sI_DFT.hpp>

Inheritance diagram for sI_DFT:

Collaboration diagram for sI_DFT:

Public Member Functions
	sI_DFT ()

virtual	~sI_DFT ()
	virtual destructor ensures use of polymorphism during destruction More...

virtual bool	evaluate_element (PatchData &pd, MsqMeshEntity *element, double &value, MsqError &err)
	Evaluate the metric for an element. More...

	sI_DFT ()

virtual	~sI_DFT ()
	virtual destructor ensures use of polymorphism during destruction More...

virtual bool	evaluate_element (PatchData &pd, MsqMeshEntity *element, double &value, MsqError &err)
	Evaluate the metric for an element. More...

Public Member Functions inherited from DistanceFromTarget
virtual	~DistanceFromTarget ()
	virtual destructor ensures use of polymorphism during destruction More...

virtual	~DistanceFromTarget ()
	virtual destructor ensures use of polymorphism during destruction More...

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_vertex (PatchData &, MsqVertex *, double &, MsqError &err)
	Evaluate the metric for a vertex. 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_vertex (PatchData &, MsqVertex *, double &, MsqError &err)
	Evaluate the metric for a vertex. 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)

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 Member Functions inherited from DistanceFromTarget
void	compute_T_matrices (MsqMeshEntity &elem, PatchData &pd, Matrix3D T[], size_t num_T, double c_k[], MsqError &err)
	For a given element, compute each corner matrix A, and given a target corner matrix W, returns $T=AW^{-1}$ for each corner. More...

bool	get_barrier_function (PatchData &pd, const double &tau, double &h, MsqError &err)

void	compute_T_matrices (MsqMeshEntity &elem, PatchData &pd, Matrix3D T[], size_t num_T, double c_k[], MsqError &err)
	For a given element, compute each corner matrix A, and given a target corner matrix W, returns $T=AW^{-1}$ for each corner. More...

bool	get_barrier_function (PatchData &pd, const double &tau, double &h, 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)

Protected Attributes inherited from QualityMetric
AveragingMethod	avgMethod

int	feasible

msq_std::string	metricName

Detailed Description

Class containing the target corner matrices for the context based smoothing.

Definition at line 50 of file includeLinks/sI_DFT.hpp.

Constructor & Destructor Documentation

sI_DFT ( )

inline

Definition at line 54 of file includeLinks/sI_DFT.hpp.

References QualityMetric::ELEMENT_BASED, QualityMetric::LINEAR, QualityMetric::NUMERICAL_GRADIENT, QualityMetric::NUMERICAL_HESSIAN, QualityMetric::set_averaging_method(), QualityMetric::set_gradient_type(), QualityMetric::set_hessian_type(), and QualityMetric::set_metric_type().

     {
       MsqError err;
       set_averaging_method(LINEAR, err); 
       set_metric_type(ELEMENT_BASED);
       set_gradient_type(NUMERICAL_GRADIENT);
       set_hessian_type(NUMERICAL_HESSIAN);
     }

Here is the call graph for this function:

virtual ~sI_DFT ( )

inlinevirtual

virtual destructor ensures use of polymorphism during destruction

Definition at line 64 of file includeLinks/sI_DFT.hpp.

65 {};

sI_DFT ( )

inline

Definition at line 54 of file src/QualityMetric/DFT/sI_DFT.hpp.

References QualityMetric::ELEMENT_BASED, QualityMetric::LINEAR, QualityMetric::NUMERICAL_GRADIENT, QualityMetric::NUMERICAL_HESSIAN, QualityMetric::set_averaging_method(), QualityMetric::set_gradient_type(), QualityMetric::set_hessian_type(), and QualityMetric::set_metric_type().

     {
       MsqError err;
       set_averaging_method(LINEAR, err); 
       set_metric_type(ELEMENT_BASED);
       set_gradient_type(NUMERICAL_GRADIENT);
       set_hessian_type(NUMERICAL_HESSIAN);
     }

Here is the call graph for this function:

virtual ~sI_DFT ( )

inlinevirtual

virtual destructor ensures use of polymorphism during destruction

Definition at line 64 of file src/QualityMetric/DFT/sI_DFT.hpp.

65 {};

Member Function Documentation

bool evaluate_element	(	PatchData &	,
		MsqMeshEntity *	,
		double &	,
		MsqError &	err
	)

virtual

Evaluate the metric for an element.

Reimplemented from QualityMetric.

Definition at line 41 of file sI_DFT.cpp.

References DistanceFromTarget::compute_T_matrices(), Mesquite::det(), Mesquite::Frobenius_2(), DistanceFromTarget::get_barrier_function(), i, MSQ_ERRZERO, Mesquite::MSQ_MAX_NUM_VERT_PER_ENT, Mesquite::MSQ_ONE_THIRD, Mesquite::MSQ_TWO_THIRDS, Mesquite::pow(), s, MsqMeshEntity::vertex_count(), and QualityMetric::weighted_average_metrics().

 {
   Matrix3D T[MSQ_MAX_NUM_VERT_PER_ENT];
   double c_k[MSQ_MAX_NUM_VERT_PER_ENT];
   double dft[MSQ_MAX_NUM_VERT_PER_ENT];
   bool return_flag = false;
   double h, tau, s;
 
   size_t num_T = element->vertex_count();
   compute_T_matrices(*element, pd, T, num_T, c_k, err); MSQ_ERRZERO(err);
 
   const double id[] = {1, 0, 0,  0, 1, 0,  0, 0, 1};
   const Matrix3D I(id);
   for (size_t i=0; i<num_T; ++i) {
     tau = det(T[i]);
     s = pow(tau, MSQ_ONE_THIRD); // for 3D (tet & hex)
     T[i] -= s*I; 
     dft[i] = .5 * Frobenius_2(T[i]);
     return_flag = get_barrier_function(pd, tau, h, err); MSQ_ERRZERO(err);
     dft[i] /= pow(h, MSQ_TWO_THIRDS);
   }
     
   value = weighted_average_metrics(c_k, dft, num_T, err); MSQ_ERRZERO(err);
     
   return return_flag;
 }

Here is the call graph for this function:

virtual bool evaluate_element	(	PatchData &	,
		MsqMeshEntity *	,
		double &	,
		MsqError &	err
	)

virtual

Evaluate the metric for an element.

Reimplemented from QualityMetric.

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation