TypeOfCellQuadrilateral.h File Reference

#include <vtkm/Math.h>
#include <vtkm/VectorAnalysis.h>

Go to the source code of this file.

Functions
template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Vector	GetQuadL0 (const CollectionOfPoints &pts)
	The Verdict manual defines a set of commonly used components of a quadrilateral (quad). More...
template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Vector	GetQuadL1 (const CollectionOfPoints &pts)
	Returns the L1 vector, as defined by the verdict manual. More...
template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Vector	GetQuadL2 (const CollectionOfPoints &pts)
	Returns the L2 vector, as defined by the verdict manual. More...
template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Vector	GetQuadL3 (const CollectionOfPoints &pts)
	Returns the L3 vector, as defined by the verdict manual. More...
template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Scalar	GetQuadL0Magnitude (const CollectionOfPoints &pts)
	Returns the L0 vector's magnitude, as defined by the verdict manual. More...
template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Scalar	GetQuadL1Magnitude (const CollectionOfPoints &pts)
	Returns the L1 vector's magnitude, as defined by the verdict manual. More...
template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Scalar	GetQuadL2Magnitude (const CollectionOfPoints &pts)
	Returns the L2 vector's magnitude, as defined by the verdict manual. More...
template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Scalar	GetQuadL3Magnitude (const CollectionOfPoints &pts)
	Returns the L3 vector's magnitude, as defined by the verdict manual. More...
template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Scalar	GetQuadLMax (const CollectionOfPoints &pts)
	Returns the Max of the magnitude of each vector which makes up the sides of the Quad. More...
template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Scalar	GetQuadLMin (const CollectionOfPoints &pts)
	Returns the Min of the magnitude of each vector which makes up the sides of the Quad. More...
template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Vector	GetQuadD0 (const CollectionOfPoints &pts)
	Returns the D0 vector, as defined by the verdict manual. More...
template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Vector	GetQuadD1 (const CollectionOfPoints &pts)
	Returns the D1 vector, as defined by the verdict manual. More...
template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Scalar	GetQuadD0Magnitude (const CollectionOfPoints &pts)
	Returns the D0 vector's magnitude, as defined by the verdict manual. More...
template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Scalar	GetQuadD1Magnitude (const CollectionOfPoints &pts)
	Returns the D0 vector's magnitude, as defined by the verdict manual. More...
template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Scalar	GetQuadDMax (const CollectionOfPoints &pts)
	Returns the Max of the magnitude of each vector which makes up the diagonals of the Quad. More...
template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Vector	GetQuadX0 (const CollectionOfPoints &pts)
	Returns the X0 vector, as defined by the verdict manual. More...
template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Vector	GetQuadX1 (const CollectionOfPoints &pts)
	Returns the X1 vector, as defined by the verdict manual. More...
template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Vector	GetQuadN0 (const CollectionOfPoints &pts)
	Returns the N0 vector, as defined by the verdict manual. More...
template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Vector	GetQuadN1 (const CollectionOfPoints &pts)
	Returns the N1 vector, as defined by the verdict manual. More...
template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Vector	GetQuadN2 (const CollectionOfPoints &pts)
	Returns the N2 vector, as defined by the verdict manual. More...
template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Vector	GetQuadN3 (const CollectionOfPoints &pts)
	Returns the N3 vector, as defined by the verdict manual. More...
template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Vector	GetQuadNc (const CollectionOfPoints &pts)
	Returns the normal center vector, as defined by the verdict manual. More...
template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Vector	GetQuadN0Normalized (const CollectionOfPoints &pts)
	Returns the normalized N0 vector, as defined by the verdict manual. More...
template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Vector	GetQuadN1Normalized (const CollectionOfPoints &pts)
	Returns the normalized N1 vector, as defined by the verdict manual. More...
template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Vector	GetQuadN2Normalized (const CollectionOfPoints &pts)
	Returns the normalized N2 vector, as defined by the verdict manual. More...
template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Vector	GetQuadN3Normalized (const CollectionOfPoints &pts)
	Returns the normalized N3 vector, as defined by the verdict manual. More...
template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Vector	GetQuadNcNormalized (const CollectionOfPoints &pts)
	Returns the normalized Nc vector, as defined by the verdict manual. More...
template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Scalar	GetQuadAlpha0 (const CollectionOfPoints &pts)
	Returns the alpha0 scalar, as defined by the verdict manual. More...
template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Scalar	GetQuadAlpha1 (const CollectionOfPoints &pts)
	Returns the alpha1 scalar, as defined by the verdict manual. More...
template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Scalar	GetQuadAlpha2 (const CollectionOfPoints &pts)
	Returns the alpha2 scalar, as defined by the verdict manual. More...
template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Scalar	GetQuadAlpha3 (const CollectionOfPoints &pts)
	Returns the alpha3 scalar, as defined by the verdict manual. More...
template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Scalar	GetQuadArea (const CollectionOfPoints &pts)
	Returns the area of the quad, as defined by the verdict manual. More...

Function Documentation

GetQuadAlpha0()

template<typename Scalar , typename Vector , typename CollectionOfPoints >

VTKM_EXEC Scalar GetQuadAlpha0

(

const CollectionOfPoints &

pts

)

Returns the alpha0 scalar, as defined by the verdict manual.

Parameters

[in]

pts

The four points which define the quadrilateral.

Returns

Returns the scalar.

GetQuadAlpha1()

template<typename Scalar , typename Vector , typename CollectionOfPoints >

VTKM_EXEC Scalar GetQuadAlpha1

(

const CollectionOfPoints &

pts

)

Returns the alpha1 scalar, as defined by the verdict manual.

Parameters

[in]

pts

The four points which define the quadrilateral.

Returns

Returns the scalar.

GetQuadAlpha2()

template<typename Scalar , typename Vector , typename CollectionOfPoints >

VTKM_EXEC Scalar GetQuadAlpha2

(

const CollectionOfPoints &

pts

)

Returns the alpha2 scalar, as defined by the verdict manual.

Parameters

[in]

pts

The four points which define the quadrilateral.

Returns

Returns the scalar.

GetQuadAlpha3()

template<typename Scalar , typename Vector , typename CollectionOfPoints >

VTKM_EXEC Scalar GetQuadAlpha3

(

const CollectionOfPoints &

pts

)

Returns the alpha3 scalar, as defined by the verdict manual.

Parameters

[in]

pts

The four points which define the quadrilateral.

Returns

Returns the scalar.

GetQuadArea()

template<typename Scalar , typename Vector , typename CollectionOfPoints >

VTKM_EXEC Scalar GetQuadArea

(

const CollectionOfPoints &

pts

)

Returns the area of the quad, as defined by the verdict manual.

Parameters

[in]

pts

The four points which define the quadrilateral.

Returns

Returns the area.

GetQuadD0()

template<typename Scalar , typename Vector , typename CollectionOfPoints >

VTKM_EXEC Vector GetQuadD0

(

const CollectionOfPoints &

pts

)

Returns the D0 vector, as defined by the verdict manual.

Parameters

[in]

pts

The four points which define the quadrilateral.

Returns

Returns the vector.

GetQuadD0Magnitude()

template<typename Scalar , typename Vector , typename CollectionOfPoints >

VTKM_EXEC Scalar GetQuadD0Magnitude

(

const CollectionOfPoints &

pts

)

Returns the D0 vector's magnitude, as defined by the verdict manual.

Parameters

[in]

pts

The four points which define the Quad.

Returns

Returns the magnitude of the vector.

GetQuadD1()

template<typename Scalar , typename Vector , typename CollectionOfPoints >

VTKM_EXEC Vector GetQuadD1

(

const CollectionOfPoints &

pts

)

Returns the D1 vector, as defined by the verdict manual.

Parameters

[in]

pts

The four points which define the quadrilateral.

Returns

Returns the vector.

GetQuadD1Magnitude()

template<typename Scalar , typename Vector , typename CollectionOfPoints >

VTKM_EXEC Scalar GetQuadD1Magnitude

(

const CollectionOfPoints &

pts

)

Returns the D0 vector's magnitude, as defined by the verdict manual.

Parameters

[in]

pts

The four points which define the Quad.

Returns

Returns the magnitude of the vector.

GetQuadDMax()

template<typename Scalar , typename Vector , typename CollectionOfPoints >

VTKM_EXEC Scalar GetQuadDMax

(

const CollectionOfPoints &

pts

)

Returns the Max of the magnitude of each vector which makes up the diagonals of the Quad.

Parameters

[in]

pts

The four points which define the Quad.

Returns

Returns the magnitude of the vector.

GetQuadL0()

template<typename Scalar , typename Vector , typename CollectionOfPoints >

VTKM_EXEC Vector GetQuadL0

(

const CollectionOfPoints &

pts

)

The Verdict manual defines a set of commonly used components of a quadrilateral (quad).

For example, area, side lengths, and so forth.

These definitions can be found starting on page 32 of the Verdict manual.

This file contains a set of functions which implement return the values of those commonly used components for subsequent use in metrics. Returns the L0 vector, as defined by the verdict manual.

Parameters

[in]

pts

The four points which define the quadrilateral.

Returns

Returns the vector.

GetQuadL0Magnitude()

template<typename Scalar , typename Vector , typename CollectionOfPoints >

VTKM_EXEC Scalar GetQuadL0Magnitude

(

const CollectionOfPoints &

pts

)

Returns the L0 vector's magnitude, as defined by the verdict manual.

Parameters

[in]

pts

The four points which define the Quad.

Returns

Returns the magnitude of the vector.

GetQuadL1()

template<typename Scalar , typename Vector , typename CollectionOfPoints >

VTKM_EXEC Vector GetQuadL1

(

const CollectionOfPoints &

pts

)

Returns the L1 vector, as defined by the verdict manual.

Parameters

[in]

pts

The four points which define the quadrilateral.

Returns

Returns the vector.

GetQuadL1Magnitude()

template<typename Scalar , typename Vector , typename CollectionOfPoints >

VTKM_EXEC Scalar GetQuadL1Magnitude

(

const CollectionOfPoints &

pts

)

Returns the L1 vector's magnitude, as defined by the verdict manual.

Parameters

[in]

pts

The four points which define the Quad.

Returns

Returns the magnitude of the vector.

GetQuadL2()

template<typename Scalar , typename Vector , typename CollectionOfPoints >

VTKM_EXEC Vector GetQuadL2

(

const CollectionOfPoints &

pts

)

Returns the L2 vector, as defined by the verdict manual.

Parameters

[in]

pts

The four points which define the quadrilateral.

Returns

Returns the vector.

GetQuadL2Magnitude()

template<typename Scalar , typename Vector , typename CollectionOfPoints >

VTKM_EXEC Scalar GetQuadL2Magnitude

(

const CollectionOfPoints &

pts

)

Returns the L2 vector's magnitude, as defined by the verdict manual.

Parameters

[in]

pts

The four points which define the Quad.

Returns

Returns the magnitude of the vector.

GetQuadL3()

template<typename Scalar , typename Vector , typename CollectionOfPoints >

VTKM_EXEC Vector GetQuadL3

(

const CollectionOfPoints &

pts

)

Returns the L3 vector, as defined by the verdict manual.

Parameters

[in]

pts

The four points which define the quadrilateral.

Returns

Returns the vector.

GetQuadL3Magnitude()

template<typename Scalar , typename Vector , typename CollectionOfPoints >

VTKM_EXEC Scalar GetQuadL3Magnitude

(

const CollectionOfPoints &

pts

)

Returns the L3 vector's magnitude, as defined by the verdict manual.

Parameters

[in]

pts

The four points which define the Quad.

Returns

Returns the magnitude of the vector.

GetQuadLMax()

template<typename Scalar , typename Vector , typename CollectionOfPoints >

VTKM_EXEC Scalar GetQuadLMax

(

const CollectionOfPoints &

pts

)

Returns the Max of the magnitude of each vector which makes up the sides of the Quad.

Parameters

[in]

pts

The four points which define the Quad.

Returns

Returns the magnitude of the vector.

GetQuadLMin()

template<typename Scalar , typename Vector , typename CollectionOfPoints >

VTKM_EXEC Scalar GetQuadLMin

(

const CollectionOfPoints &

pts

)

Returns the Min of the magnitude of each vector which makes up the sides of the Quad.

Parameters

[in]

pts

The four points which define the Quad.

Returns

Returns the magnitude of the vector.

GetQuadN0()

template<typename Scalar , typename Vector , typename CollectionOfPoints >

VTKM_EXEC Vector GetQuadN0

(

const CollectionOfPoints &

pts

)

Returns the N0 vector, as defined by the verdict manual.

Parameters

[in]

pts

The four points which define the quadrilateral.

Returns

Returns the vector.

GetQuadN0Normalized()

template<typename Scalar , typename Vector , typename CollectionOfPoints >

VTKM_EXEC Vector GetQuadN0Normalized

(

const CollectionOfPoints &

pts

)

Returns the normalized N0 vector, as defined by the verdict manual.

Parameters

[in]

pts

The four points which define the quadrilateral.

Returns

Returns the vector.

GetQuadN1()

template<typename Scalar , typename Vector , typename CollectionOfPoints >

VTKM_EXEC Vector GetQuadN1

(

const CollectionOfPoints &

pts

)

Returns the N1 vector, as defined by the verdict manual.

Parameters

[in]

pts

The four points which define the quadrilateral.

Returns

Returns the vector.

GetQuadN1Normalized()

template<typename Scalar , typename Vector , typename CollectionOfPoints >

VTKM_EXEC Vector GetQuadN1Normalized

(

const CollectionOfPoints &

pts

)

Returns the normalized N1 vector, as defined by the verdict manual.

Parameters

[in]

pts

The four points which define the quadrilateral.

Returns

Returns the vector.

GetQuadN2()

template<typename Scalar , typename Vector , typename CollectionOfPoints >

VTKM_EXEC Vector GetQuadN2

(

const CollectionOfPoints &

pts

)

Returns the N2 vector, as defined by the verdict manual.

Parameters

[in]

pts

The four points which define the quadrilateral.

Returns

Returns the vector.

GetQuadN2Normalized()

template<typename Scalar , typename Vector , typename CollectionOfPoints >

VTKM_EXEC Vector GetQuadN2Normalized

(

const CollectionOfPoints &

pts

)

Returns the normalized N2 vector, as defined by the verdict manual.

Parameters

[in]

pts

The four points which define the quadrilateral.

Returns

Returns the vector.

GetQuadN3()

template<typename Scalar , typename Vector , typename CollectionOfPoints >

VTKM_EXEC Vector GetQuadN3

(

const CollectionOfPoints &

pts

)

Returns the N3 vector, as defined by the verdict manual.

Parameters

[in]

pts

The four points which define the quadrilateral.

Returns

Returns the vector.

GetQuadN3Normalized()

template<typename Scalar , typename Vector , typename CollectionOfPoints >

VTKM_EXEC Vector GetQuadN3Normalized

(

const CollectionOfPoints &

pts

)

Returns the normalized N3 vector, as defined by the verdict manual.

Parameters

[in]

pts

The four points which define the quadrilateral.

Returns

Returns the vector.

GetQuadNc()

template<typename Scalar , typename Vector , typename CollectionOfPoints >

VTKM_EXEC Vector GetQuadNc

(

const CollectionOfPoints &

pts

)

Returns the normal center vector, as defined by the verdict manual.

Parameters

[in]

pts

The four points which define the quadrilateral.

Returns

Returns the vector.

GetQuadNcNormalized()

template<typename Scalar , typename Vector , typename CollectionOfPoints >

VTKM_EXEC Vector GetQuadNcNormalized

(

const CollectionOfPoints &

pts

)

Returns the normalized Nc vector, as defined by the verdict manual.

Parameters

[in]

pts

The four points which define the quadrilateral.

Returns

Returns the vector.

GetQuadX0()

template<typename Scalar , typename Vector , typename CollectionOfPoints >

VTKM_EXEC Vector GetQuadX0

(

const CollectionOfPoints &

pts

)

Returns the X0 vector, as defined by the verdict manual.

Parameters

[in]

pts

The four points which define the quadrilateral.

Returns

Returns the vector.

GetQuadX1()

template<typename Scalar , typename Vector , typename CollectionOfPoints >

VTKM_EXEC Vector GetQuadX1

(

const CollectionOfPoints &

pts

)

Returns the X1 vector, as defined by the verdict manual.

Parameters

[in]

pts

The four points which define the quadrilateral.

Returns

Returns the vector.