I_DFT metric with mAlpha = .5, mBeta = 1, mGamma = 0. More...

#include <I_DFT_NoBarrier.hpp>

Inheritance diagram for I_DFT_NoBarrier:

Collaboration diagram for I_DFT_NoBarrier:

Public Member Functions
	I_DFT_NoBarrier ()

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

	I_DFT_NoBarrier ()

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

Public Member Functions inherited from I_DFT
	I_DFT ()

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

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

bool	compute_element_analytical_gradient (PatchData &pd, MsqMeshEntity e, MsqVertex fv[], Vector3D g[], int nfv, double &m, 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_analytical_hessian (PatchData &pd, MsqMeshEntity e, MsqVertex fv[], Vector3D g[], Matrix3D h[], int nfv, double &m, MsqError &err)

	I_DFT ()

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

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

bool	compute_element_analytical_gradient (PatchData &pd, MsqMeshEntity e, MsqVertex fv[], Vector3D g[], int nfv, double &m, 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_analytical_hessian (PatchData &pd, MsqMeshEntity e, MsqVertex fv[], Vector3D g[], Matrix3D h[], int nfv, double &m, MsqError &err)

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 I_DFT
void	p_set_alpha (double alpha)
	access function to set mAlpha More...

double	p_get_alpha ()
	access function to get mAlpha More...

void	p_set_beta (double beta)
	access function to set mBeta More...

double	p_get_beta ()
	access function to get mBeta More...

void	p_set_gamma (double gamma)
	access function to set mGamma More...

double	p_get_gamma ()
	access function to get mGamma More...

void	p_set_use_barrier_delta (bool use_delta)
	access function to set useBarrierDelta More...

bool	p_get_use_barrier_delta ()
	access function to get useBarrierDelta More...

void	p_set_alpha (double alpha)
	access function to set mAlpha More...

double	p_get_alpha ()
	access function to get mAlpha More...

void	p_set_beta (double beta)
	access function to set mBeta More...

double	p_get_beta ()
	access function to get mBeta More...

void	p_set_gamma (double gamma)
	access function to set mGamma More...

double	p_get_gamma ()
	access function to get mGamma More...

void	p_set_use_barrier_delta (bool use_delta)
	access function to set useBarrierDelta More...

bool	p_get_use_barrier_delta ()
	access function to get useBarrierDelta More...

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...

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)

	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...

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)

Protected Attributes inherited from QualityMetric
AveragingMethod	avgMethod

int	feasible

msq_std::string	metricName

Detailed Description

I_DFT metric with mAlpha = .5, mBeta = 1, mGamma = 0.

The form of this metric is as follows (taken from I_DFTFamilyFunctions.hpp, see that file for more detail):

              mAlpha * || A*inv(W) - mBeta * I ||_F^2                    \n

---------------------------------------------------------------—
0.5^(mGamma)*(det(A*inv(W)) + sqrt(det(A*inv(W))^2 + 4*delta^2))^(mGamma)
The default for data members (corresponding to the variables above):

  mAlpha = 1/2
  mBeta = 1.0 \n
  mGamma = 0.0; \n

delta, above, is calculated use PatchData::get_barrier_delta(), but is essentially not used with mGamma = 0.0.

Definition at line 66 of file includeLinks/I_DFT_NoBarrier.hpp.

Constructor & Destructor Documentation

I_DFT_NoBarrier ( )

inline

Definition at line 70 of file includeLinks/I_DFT_NoBarrier.hpp.

References I_DFT::p_set_alpha(), I_DFT::p_set_beta(), I_DFT::p_set_gamma(), I_DFT::p_set_use_barrier_delta(), and QualityMetric::set_name().

     {
       set_name("I_DFT_NoBarrier");
       p_set_alpha(1.0/2.0);
       p_set_beta(1.0);
       p_set_gamma(0.0);
         //Note:  it seems as the use barrier delta should be false.  However,
         // since we are doing a calculation like ( pow(f(delta,x), gamma) )
         // having a non-zero f(delta,x) provides numerical stability.
       p_set_use_barrier_delta(false);      
    }

Here is the call graph for this function:

virtual ~I_DFT_NoBarrier ( )

inlinevirtual

virtual destructor ensures use of polymorphism during destruction

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

84 {};

I_DFT_NoBarrier ( )

inline

Definition at line 70 of file src/QualityMetric/DFT/I_DFT_NoBarrier.hpp.

References I_DFT::p_set_alpha(), I_DFT::p_set_beta(), I_DFT::p_set_gamma(), I_DFT::p_set_use_barrier_delta(), and QualityMetric::set_name().

     {
       set_name("I_DFT_NoBarrier");
       p_set_alpha(1.0/2.0);
       p_set_beta(1.0);
       p_set_gamma(0.0);
         //Note:  it seems as the use barrier delta should be false.  However,
         // since we are doing a calculation like ( pow(f(delta,x), gamma) )
         // having a non-zero f(delta,x) provides numerical stability.
       p_set_use_barrier_delta(false);      
    }

Here is the call graph for this function:

virtual ~I_DFT_NoBarrier ( )

inlinevirtual

virtual destructor ensures use of polymorphism during destruction

Definition at line 83 of file src/QualityMetric/DFT/I_DFT_NoBarrier.hpp.

84 {};

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation