MBMesquite::AWShapeOrientNB1 Class Reference

#include <AWShapeOrientNB1.hpp>

Inheritance diagram for MBMesquite::AWShapeOrientNB1:

Collaboration diagram for MBMesquite::AWShapeOrientNB1:

Public Member Functions
virtual MESQUITE_EXPORT	~AWShapeOrientNB1 ()
virtual MESQUITE_EXPORT std::string	get_name () const
virtual MESQUITE_EXPORT bool	evaluate (const MsqMatrix< 2, 2 > &A, const MsqMatrix< 2, 2 > &W, double &result, MsqError &err)
	Evaluate \(\mu(A,W)\).
virtual MESQUITE_EXPORT bool	evaluate_with_grad (const MsqMatrix< 2, 2 > &A, const MsqMatrix< 2, 2 > &W, double &result, MsqMatrix< 2, 2 > &deriv_wrt_A, MsqError &err)
	Gradient of \(\mu(A,W)\) with respect to components of A.
virtual MESQUITE_EXPORT bool	evaluate (const MsqMatrix< 3, 3 > &A, const MsqMatrix< 3, 3 > &W, double &result, MsqError &err)
	Evaluate \(\mu(A,W)\).
virtual MESQUITE_EXPORT bool	evaluate_with_grad (const MsqMatrix< 3, 3 > &A, const MsqMatrix< 3, 3 > &W, double &result, MsqMatrix< 3, 3 > &deriv_wrt_A, MsqError &err)
	Gradient of \(\mu(A,W)\) with respect to components of A.

---

Detailed Description

\( (|A||W| - A \cdot W)^2 \)

Definition at line 42 of file AWShapeOrientNB1.hpp.

---

Constructor & Destructor Documentation

MBMesquite::AWShapeOrientNB1::~AWShapeOrientNB1

(

)

[virtual]

Definition at line 46 of file AWShapeOrientNB1.cpp.

{}

---

Member Function Documentation

virtual MESQUITE_EXPORT bool MBMesquite::AWShapeOrientNB1::evaluate	(	const MsqMatrix< 2, 2 > &	A,
		const MsqMatrix< 2, 2 > &	W,
		double &	result,
		MsqError &	err
	)		[virtual]

Evaluate \(\mu(A,W)\).

Parameters:

A	2x2 active matrix
W	2x2 target matrix
result	Output: value of function

Returns:

false if function cannot be evaluated for given A and W (e.g. division by zero, etc.), true otherwise.

Reimplemented from MBMesquite::AWMetric.

virtual MESQUITE_EXPORT bool MBMesquite::AWShapeOrientNB1::evaluate	(	const MsqMatrix< 3, 3 > &	A,
		const MsqMatrix< 3, 3 > &	W,
		double &	result,
		MsqError &	err
	)		[virtual]

Evaluate \(\mu(A,W)\).

Parameters:

A	3x3 active matrix
W	3x3 target matrix
result	Output: value of function

Returns:

false if function cannot be evaluated for given A and W (e.g. division by zero, etc.), true otherwise.

Reimplemented from MBMesquite::AWMetric.

virtual MESQUITE_EXPORT bool MBMesquite::AWShapeOrientNB1::evaluate_with_grad	(	const MsqMatrix< 2, 2 > &	A,
		const MsqMatrix< 2, 2 > &	W,
		double &	result,
		MsqMatrix< 2, 2 > &	deriv_wrt_A,
		MsqError &	err
	)		[virtual]

Gradient of \(\mu(A,W)\) with respect to components of A.

Parameters:

A	2x2 active matrix
W	2x2 target matrix
result	Output: value of function
deriv_wrt_A	Output: partial deriviatve of \(\mu\) wrt each term of A, evaluated at passed A. \[\left[\begin{array}{cc} \frac{\partial\mu}{\partial A_{0,0}} & \frac{\partial\mu}{\partial A_{0,1}} \\ \frac{\partial\mu}{\partial A_{1,0}} & \frac{\partial\mu}{\partial A_{1,1}} \\ \end{array}\right]\]

Returns:

false if function cannot be evaluated for given A and W (e.g. division by zero, etc.), true otherwise.

Reimplemented from MBMesquite::AWMetric.

virtual MESQUITE_EXPORT bool MBMesquite::AWShapeOrientNB1::evaluate_with_grad	(	const MsqMatrix< 3, 3 > &	A,
		const MsqMatrix< 3, 3 > &	W,
		double &	result,
		MsqMatrix< 3, 3 > &	deriv_wrt_A,
		MsqError &	err
	)		[virtual]

Gradient of \(\mu(A,W)\) with respect to components of A.

Parameters:

A	3x3 active matrix
W	3x3 target matrix
result	Output: value of function
deriv_wrt_A	Output: partial deriviatve of \(\mu\) wrt each term of A, evaluated at passed A. \[\left[\begin{array}{ccc} \frac{\partial\mu}{\partial A_{0,0}} & \frac{\partial\mu}{\partial A_{0,1}} & \frac{\partial\mu}{\partial A_{0,2}} \\ \frac{\partial\mu}{\partial A_{1,0}} & \frac{\partial\mu}{\partial A_{1,1}} & \frac{\partial\mu}{\partial A_{1,2}} \\ \frac{\partial\mu}{\partial A_{2,0}} & \frac{\partial\mu}{\partial A_{2,1}} & \frac{\partial\mu}{\partial A_{2,2}} \end{array}\right]\]

Returns:

false if function cannot be evaluated for given A and W (e.g. division by zero, etc.), true otherwise.

Reimplemented from MBMesquite::AWMetric.

std::string MBMesquite::AWShapeOrientNB1::get_name

(

)

const [virtual]

Reimplemented from MBMesquite::AWMetricNonBarrier.

Definition at line 41 of file AWShapeOrientNB1.cpp.

{
    return "AWShapeOrientNB1";
}

List of all members.

---

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

• AWShapeOrientNB1.hpp
• AWShapeOrientNB1.cpp