SimplexJacQF< N, T > Class Template Reference

Simplex quality functions of the Jacobian matrix. More...

#include <SimplexJacQF.h>

Inheritance diagram for SimplexJacQF< N, T >:

Public Types
typedef T	Number
	The number type.
typedef Jacobian::Vertex	Vertex
	The class for a vertex.
typedef Jacobian::Simplex	Simplex
	The simplex type.
typedef Jacobian::Matrix	Matrix
	An NxN matrix.
Public Member Functions
Constructors etc.

	SimplexJacQF ()
	Default constructor. Un-initialized memory.
	SimplexJacQF (const SimplexJacQF &other)
	Copy constructor.
	SimplexJacQF (const Simplex &s)
	Construct from a simplex.
SimplexJacQF &	operator= (const SimplexJacQF &other)
	Assignment operator.
	~SimplexJacQF ()
	Trivial destructor.
Manipulators

void	setFunction (const Simplex &s)
	Set the vertices in preparation for a function call.
void	set (const Simplex &s)
	Set the vertices in preparation for a function call or a gradient call.
void	setFunction (const geom::Simplex< N, ads::FixedArray< N+1, Number >, Number > &s)
	Set the vertices in preparation for a function call.
void	setFunction (const geom::Simplex< N, ads::FixedArray< N+2, Number >, Number > &s)
	Set the vertices in preparation for a function call.
void	set (const geom::Simplex< N, ads::FixedArray< N+1, Number >, Number > &s)
	Set the vertices in preparation for a function call or a gradient call.
Accessors.

const Matrix &	getMatrix () const
	Return a const reference to the Jacobian matrix.
const ads::FixedArray< N, Matrix > &	getGradientMatrix () const
	Return a const reference to the gradient of the Jacobian matrix.
Number	getDeterminant () const
	Return the determinant of the Jacobian matrix.
const Vertex &	getGradientDeterminant () const
	Return a const reference to the gradient of the determinant of the Jacobian matrix.
Number	computeContent () const
	Return the content (hypervolume) of the simplex.
void	computeGradientContent (Vertex *grad) const
	Calculate the gradient of the content (hypervolume) of the simplex.
Vertex	computeGradientContent () const
	Return the gradient of the content (hypervolume) of the simplex.
static int	getDimension ()
	Return the space dimension.

Detailed Description

template<int N, typename T = double>
class SimplexJacQF< N, T >

Simplex quality functions of the Jacobian matrix.

Parameters:

	N	is the dimension.
	T	is the number type. By default it is double.

This is a base class for simplex quality functions that uses the Jacobian matrix. It has member functions for evaluating the determinant and content of the simplex.

getDeterminant() returns the determinant of the Jacobian matrix.
computeContent() returns the content.
computeGradientContent() calculates the gradient of the content.

Before calling getDeterminant() or computeContent(), you must set the Jacobian matrix with setFunction() or set(). Before calling computeGradientContent(), you must set the Jacobian matrix and its gradient with set().