VTK-m  2.0
Functions
TypeOfCellTriangle.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 GetTriangleL0 (const CollectionOfPoints &pts)
 The Verdict manual defines a set of commonly used components of a triangle. More...
 
template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Vector GetTriangleL1 (const CollectionOfPoints &pts)
 Returns the L1 vector, as defined by the verdict manual. More...
 
template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Vector GetTriangleL2 (const CollectionOfPoints &pts)
 Returns the L2 vector, as defined by the verdict manual. More...
 
template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Scalar GetTriangleL0Magnitude (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 GetTriangleL1Magnitude (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 GetTriangleL2Magnitude (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 GetTriangleLMax (const CollectionOfPoints &pts)
 Returns the Max of the magnitude of each vector which makes up the sides of the triangle. More...
 
template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Scalar GetTriangleLMin (const CollectionOfPoints &pts)
 Returns the Min of the magnitude of each vector which makes up the sides of the triangle. More...
 
template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Scalar GetTriangleArea (const CollectionOfPoints &pts)
 Returns the area of the triangle. More...
 
template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Scalar GetTriangleInradius (const CollectionOfPoints &pts)
 Returns the radius of a circle inscribed within the given triangle. More...
 
template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Scalar GetTriangleCircumradius (const CollectionOfPoints &pts)
 Returns the radius of a circle circumscribed around the given triangle. More...
 

Function Documentation

◆ GetTriangleArea()

template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Scalar GetTriangleArea ( const CollectionOfPoints &  pts)

Returns the area of the triangle.

Parameters
[in]ptsThe three points which define the verticies of the triangle.
Returns
Returns the are of the triangle..

◆ GetTriangleCircumradius()

template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Scalar GetTriangleCircumradius ( const CollectionOfPoints &  pts)

Returns the radius of a circle circumscribed around the given triangle.

This is commonly denoted as 'R'.

Parameters
[in]ptsThe three points which define the verticies of the triangle.
Returns
Returns the circumradius.

◆ GetTriangleInradius()

template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Scalar GetTriangleInradius ( const CollectionOfPoints &  pts)

Returns the radius of a circle inscribed within the given triangle.

This is commonly denoted as 'r'.

Parameters
[in]ptsThe three points which define the verticies of the triangle.
Returns
Returns the inradius.

◆ GetTriangleL0()

template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Vector GetTriangleL0 ( const CollectionOfPoints &  pts)

The Verdict manual defines a set of commonly used components of a triangle.

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

These definitions can be found starting on page 17 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]ptsThe three points which define the triangle.
Returns
Returns the vector.

◆ GetTriangleL0Magnitude()

template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Scalar GetTriangleL0Magnitude ( const CollectionOfPoints &  pts)

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

Parameters
[in]ptsThe three points which define the triangle.
Returns
Returns the magnitude of the vector.

◆ GetTriangleL1()

template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Vector GetTriangleL1 ( const CollectionOfPoints &  pts)

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

Parameters
[in]ptsThe three points which define the triangle.
Returns
Returns the vector.

◆ GetTriangleL1Magnitude()

template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Scalar GetTriangleL1Magnitude ( const CollectionOfPoints &  pts)

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

Parameters
[in]ptsThe three points which define the triangle.
Returns
Returns the magnitude of the vector.

◆ GetTriangleL2()

template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Vector GetTriangleL2 ( const CollectionOfPoints &  pts)

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

Parameters
[in]ptsThe three points which define the triangle.
Returns
Returns the vector.

◆ GetTriangleL2Magnitude()

template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Scalar GetTriangleL2Magnitude ( const CollectionOfPoints &  pts)

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

Parameters
[in]ptsThe three points which define the triangle.
Returns
Returns the magnitude of the vector.

◆ GetTriangleLMax()

template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Scalar GetTriangleLMax ( const CollectionOfPoints &  pts)

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

That is to say, the length of the longest side.

Parameters
[in]ptsThe three points which define the verticies of the triangle.
Returns
Returns the max of the triangle side lengths.

◆ GetTriangleLMin()

template<typename Scalar , typename Vector , typename CollectionOfPoints >
VTKM_EXEC Scalar GetTriangleLMin ( const CollectionOfPoints &  pts)

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

That is to say, the length of the shortest side.

Parameters
[in]ptsThe three points which define the verticies of the triangle.
Returns
Returns the max of the triangle side lengths.