Multiplies quality metric value by a number (a double). More...

#include <ScalarMultiplyQualityMetric.hpp>

Inheritance diagram for MBMesquite::ScalarMultiplyQualityMetric:

Collaboration diagram for MBMesquite::ScalarMultiplyQualityMetric:

Public Member Functions
	ScalarMultiplyQualityMetric (QualityMetric *metric, double scale)
	~ScalarMultiplyQualityMetric ()
MetricType	get_metric_type () const
std::string	get_name () const
int	get_negate_flag () const
	1 if metric should be minimized, -1 if metric should be maximized.
void	get_evaluations (PatchData &pd, std::vector< size_t > &handles, bool free_vertices_only, MsqError &err)
	Get locations at which metric can be evaluated.
bool	evaluate (PatchData &pd, size_t handle, double &value, MsqError &err)
	Get metric value at a logical location in the patch.
bool	evaluate_with_indices (PatchData &pd, size_t handle, double &value, std::vector< size_t > &indices, MsqError &err)
	Get metric value at a logical location in the patch.
bool	evaluate_with_gradient (PatchData &pd, size_t handle, double &value, std::vector< size_t > &indices, std::vector< Vector3D > &gradient, MsqError &err)
	Get metric value and gradient at a logical location in the patch.
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)
	Get metric value and deravitives at a logical location in the patch.
Private Attributes
QualityMetric *	mMetric
double	mScale

Detailed Description

Multiplies quality metric value by a number (a double).

Definition at line 49 of file ScalarMultiplyQualityMetric.hpp.

Constructor & Destructor Documentation

MBMesquite::ScalarMultiplyQualityMetric::ScalarMultiplyQualityMetric	(	QualityMetric *	metric,
		double	scale
	)		`[inline]`

Definition at line 52 of file ScalarMultiplyQualityMetric.hpp.

: mMetric( metric ), mScale( scale ) {}

MBMesquite::ScalarMultiplyQualityMetric::~ScalarMultiplyQualityMetric ( ) [inline]

Definition at line 54 of file ScalarMultiplyQualityMetric.hpp.

{}

Member Function Documentation

bool ScalarMultiplyQualityMetric::evaluate	(	PatchData &	pd,
		size_t	handle,
		double &	value,
		MsqError &	err
	)		`[virtual]`

Get metric value at a logical location in the patch.

Evaluate the metric at one location in the PatchData.

Parameters:

pd	The patch.
handle	The location in the patch (as passed back from get_evaluations).
value	The output metric value.

Implements MBMesquite::QualityMetric.

Definition at line 55 of file ScalarMultiplyQualityMetric.cpp.

References MBMesquite::QualityMetric::evaluate(), mMetric, and mScale.

{
    bool rval = mMetric->evaluate( pd, handle, value, err );
    value *= mScale;
    return rval;
}

bool ScalarMultiplyQualityMetric::evaluate_with_gradient	(	PatchData &	pd,
		size_t	handle,
		double &	value,
		std::vector< size_t > &	indices,
		std::vector< Vector3D > &	gradient,
		MsqError &	err
	)		`[virtual]`

Get metric value and gradient at a logical location in the patch.

Evaluate the metric at one location in the PatchData.

Parameters:

pd	The patch.
handle	The location in the patch (as passed back from get_evaluations).
value	The output metric value.
indices	The free vertices that the evaluation is a function of, specified as vertex indices in the PatchData.
gradient	The gradient of the metric as a function of the coordinates of the free vertices passed back in the indices list.

Reimplemented from MBMesquite::QualityMetric.

Definition at line 73 of file ScalarMultiplyQualityMetric.cpp.

References MBMesquite::QualityMetric::evaluate_with_gradient(), mMetric, mScale, and MSQ_CHKERR.

{
    bool rval = mMetric->evaluate_with_gradient( pd, handle, value, indices, gradient, err );
    value *= mScale;
    for( std::vector< Vector3D >::iterator i = gradient.begin(); i != gradient.end(); ++i )
        *i *= mScale;
    return !MSQ_CHKERR( err ) && rval;
}

bool ScalarMultiplyQualityMetric::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
	)		`[virtual]`

Get metric value and deravitives at a logical location in the patch.

Evaluate the metric at one location in the PatchData.

Parameters:

pd	The patch.
handle	The location in the patch (as passed back from get_evaluations).
value	The output metric value.
indices	The free vertices that the evaluation is a function of, specified as vertex indices in the PatchData.
gradient	The gradient of the metric as a function of the coordinates of the free vertices passed back in the indices list.
Hessian	The Hessian of the metric as a function of the coordinates. The Hessian is passed back as the upper-triangular portion of the matrix in row-major order, where each Matrix3D is the portion of the Hessian with respect to the vertices at the corresponding positions in the indices list.

Reimplemented from MBMesquite::QualityMetric.

Definition at line 87 of file ScalarMultiplyQualityMetric.cpp.

References MBMesquite::QualityMetric::evaluate_with_Hessian(), mMetric, mScale, and MSQ_CHKERR.

{
    bool rval = mMetric->evaluate_with_Hessian( pd, handle, value, indices, gradient, Hessian, err );
    value *= mScale;
    for( std::vector< Vector3D >::iterator i = gradient.begin(); i != gradient.end(); ++i )
        *i *= mScale;
    for( std::vector< Matrix3D >::iterator j = Hessian.begin(); j != Hessian.end(); ++j )
        *j *= mScale;
    return !MSQ_CHKERR( err ) && rval;
}

bool ScalarMultiplyQualityMetric::evaluate_with_indices	(	PatchData &	pd,
		size_t	handle,
		double &	value,
		std::vector< size_t > &	indices,
		MsqError &	err
	)		`[virtual]`

Get metric value at a logical location in the patch.

Evaluate the metric at one location in the PatchData.

Parameters:

pd	The patch.
handle	The location in the patch (as passed back from get_evaluations).
value	The output metric value.
indices	The free vertices that the evaluation is a function of, specified as vertex indices in the PatchData.

Implements MBMesquite::QualityMetric.

Definition at line 62 of file ScalarMultiplyQualityMetric.cpp.

References MBMesquite::QualityMetric::evaluate_with_indices(), mMetric, mScale, and MSQ_CHKERR.

{
    bool rval = mMetric->evaluate_with_indices( pd, handle, value, indices, err );
    value *= mScale;
    return !MSQ_CHKERR( err ) && rval;
}

void ScalarMultiplyQualityMetric::get_evaluations	(	PatchData &	pd,
		std::vector< size_t > &	handles,
		bool	free_vertices_only,
		MsqError &	err
	)		`[virtual]`

Get locations at which metric can be evaluated.

Different metrics are evaluated for different things within a patch. For example, an element-based metric will be evaluated once for each element in patch, a vertex-based metric once for each veretx, and a target/sample-point based metric will be evaluated once for each samle point in each element. This method returns a list of handles, one for each location in the patch at which the metric can be evaluated. The handle values are used as input to the evaluate methods.

Parameters:

pd	The patch
handles	Output list of handles
free_vertices_only	If true, only pass back evaluation points that depend on at least one free vertex.

Implements MBMesquite::QualityMetric.

Definition at line 47 of file ScalarMultiplyQualityMetric.cpp.

References MBMesquite::QualityMetric::get_evaluations(), mMetric, and MSQ_CHKERR.

{
    mMetric->get_evaluations( pd, handles, free_vertices_only, err );MSQ_CHKERR( err );
}

MetricType MBMesquite::ScalarMultiplyQualityMetric::get_metric_type ( ) const [inline, virtual]

Implements MBMesquite::QualityMetric.

Definition at line 56 of file ScalarMultiplyQualityMetric.hpp.

References MBMesquite::QualityMetric::get_metric_type(), and mMetric.

    {
        return mMetric->get_metric_type();
    }

std::string ScalarMultiplyQualityMetric::get_name ( ) const [virtual]

Implements MBMesquite::QualityMetric.

Definition at line 42 of file ScalarMultiplyQualityMetric.cpp.

References MBMesquite::QualityMetric::get_name(), and mMetric.

{
    return std::string( "Scale(" ) + mMetric->get_name() + ")";
}

int MBMesquite::ScalarMultiplyQualityMetric::get_negate_flag ( ) const [inline, virtual]

1 if metric should be minimized, -1 if metric should be maximized.

Implements MBMesquite::QualityMetric.

Definition at line 63 of file ScalarMultiplyQualityMetric.hpp.

References MBMesquite::QualityMetric::get_negate_flag(), and mMetric.

    {
        return mMetric->get_negate_flag();
    }

Member Data Documentation

QualityMetric* MBMesquite::ScalarMultiplyQualityMetric::mMetric [private]

Definition at line 94 of file ScalarMultiplyQualityMetric.hpp.

Referenced by evaluate(), evaluate_with_gradient(), evaluate_with_Hessian(), evaluate_with_indices(), get_evaluations(), get_metric_type(), get_name(), and get_negate_flag().

double MBMesquite::ScalarMultiplyQualityMetric::mScale [private]

Definition at line 95 of file ScalarMultiplyQualityMetric.hpp.

Referenced by evaluate(), evaluate_with_gradient(), evaluate_with_Hessian(), and evaluate_with_indices().

List of all members.

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation