mpblocks::clarkson93::ExampleTraits2< SCALAR, NDIM > Struct Template Reference

documents the interface for Traits : encapsulates various policies for the Triangulation More...

#include <mpblocks/clarkson93/ExampleTraits2.h>

Classes
struct	Callback
	the triangulation provides some static callbacks for when hull faces are added or removed. If we wish to do anything special this is where we can hook into them. If you do not wish to hook into the callbacks then simply create an empty structure which has empty implementation for these More...
struct	Deref
	proves a means of turning a PointRef into a Point& More...
struct	Simplex
	The derived type to use for simplices. More...
struct	SimplexMgr
	template for allocators & memory managers More...

Public Types
typedef Eigen::Matrix< Scalar, NDim, 1 >	Point
	Data structure for representing points. More...
typedef Point *	PointRef
	a reference to a point More...
typedef SCALAR	Scalar
	number format for scalar numbers More...
typedef clarkson93::SimplexOps < This >	SimplexOps
	Triangulation will derive from this in order to inherit operations for simplices. More...
typedef Simplex *	SimplexRef
	a reference to a simplex More...
typedef ExampleTraits2< SCALAR, NDIM >	This

Static Public Attributes
static const unsigned int	NDim = NDIM
	dimension of the embeded space, use clarkson93::Dynamic for a datastructure whose dimension is set at runtime More...
static const int	OptLevel = 0
	optimization levels More...

Detailed Description

template<typename SCALAR, unsigned int NDIM>
struct mpblocks::clarkson93::ExampleTraits2< SCALAR, NDIM >

documents the interface for Traits : encapsulates various policies for the Triangulation

Todo:

Should these traits be split up into multiple policy classes?

Definition at line 43 of file ExampleTraits2.h.

Member Typedef Documentation

template<typename SCALAR , unsigned int NDIM>

typedef Eigen::Matrix<Scalar,NDim,1> mpblocks::clarkson93::ExampleTraits2< SCALAR, NDIM >::Point

Data structure for representing points.

Currently only Eigen::Matrix<Scalar,NDim,1> is supported b/c we utilize this structure in solving a linear system. Technically anything that derives from Eigen::MatrixBase will work because it just needs to be assignable to an Eigen::Matrix::row() and from an Eigen::Vector when we solve for the normal and offset of the base facet. In the future I may generalize the solving of the linear system in which case that functionality will be a requirement of the traits class

Definition at line 74 of file ExampleTraits2.h.

template<typename SCALAR , unsigned int NDIM>

typedef Point* mpblocks::clarkson93::ExampleTraits2< SCALAR, NDIM >::PointRef

a reference to a point

Definition at line 77 of file ExampleTraits2.h.

template<typename SCALAR , unsigned int NDIM>

typedef SCALAR mpblocks::clarkson93::ExampleTraits2< SCALAR, NDIM >::Scalar

number format for scalar numbers

Definition at line 61 of file ExampleTraits2.h.

template<typename SCALAR , unsigned int NDIM>

typedef clarkson93::SimplexOps<This> mpblocks::clarkson93::ExampleTraits2< SCALAR, NDIM >::SimplexOps

Triangulation will derive from this in order to inherit operations for simplices.

Definition at line 134 of file ExampleTraits2.h.

template<typename SCALAR , unsigned int NDIM>

typedef Simplex* mpblocks::clarkson93::ExampleTraits2< SCALAR, NDIM >::SimplexRef

a reference to a simplex

Definition at line 83 of file ExampleTraits2.h.

template<typename SCALAR , unsigned int NDIM>

typedef ExampleTraits2<SCALAR,NDIM> mpblocks::clarkson93::ExampleTraits2< SCALAR, NDIM >::This

Definition at line 45 of file ExampleTraits2.h.

Member Data Documentation

template<typename SCALAR , unsigned int NDIM>

const unsigned int mpblocks::clarkson93::ExampleTraits2< SCALAR, NDIM >::NDim = NDIM

static

dimension of the embeded space, use clarkson93::Dynamic for a datastructure whose dimension is set at runtime

Definition at line 58 of file ExampleTraits2.h.

template<typename SCALAR , unsigned int NDIM>

const int mpblocks::clarkson93::ExampleTraits2< SCALAR, NDIM >::OptLevel = 0

static

optimization levels

level	details
0	General implementation wigh generic point and simplex

| references, and generic operations for each

Definition at line 54 of file ExampleTraits2.h.

---

The documentation for this struct was generated from the following file:

• include/mpblocks/clarkson93/ExampleTraits2.h