hpp::GridOrientationGenerator< U > Class Template Reference

Generates orientations on a fixed grid over an azimuthal angle of \( [0, 2\pi) \) and a zenithal angle of \( [0, \pi/2) \). Does not cover the area of a sphere equally. More...

#include <casesUtils.h>

Inheritance diagram for hpp::GridOrientationGenerator< U >:

Collaboration diagram for hpp::GridOrientationGenerator< U >:

Public Member Functions
	GridOrientationGenerator (int nTheta=8, int nPhi=4)
	Default constructor. More...
virtual void	generateNext (EulerAngles< U > &angles)
	Generate the next orientation in the sequence. More...
virtual void	generateNext (Tensor2< U > &rotMatrix)
	Generate the next orientation in the sequence. More...
Public Member Functions inherited from hpp::OrientationGenerator< U >
virtual	~OrientationGenerator ()
	Default destructor. More...

Private Attributes
int	nTheta
	the number of grid points for the azimuthal angle More...
int	nPhi
	the number of grid points for the zenithal angle More...
int	iTheta = 0
	the azimuthal index of the orientation to generate next More...
int	iPhi = 0
	the zenithal index of the orientation to generate next More...
U	dTheta
	the spacing between azimuthal angles on the grid More...
U	dPhi
	the spacing between zenithal angles on the grid More...

Detailed Description

template<typename U>
class hpp::GridOrientationGenerator< U >

Generates orientations on a fixed grid over an azimuthal angle of \( [0, 2\pi) \) and a zenithal angle of \( [0, \pi/2) \). Does not cover the area of a sphere equally.

Author

Michael Malahe

Date

28/09/17

Constructor & Destructor Documentation

template<typename U >

hpp::GridOrientationGenerator< U >::GridOrientationGenerator	(	int	nTheta = 8,
		int	nPhi = 4
	)

Default constructor.

Parameters

nTheta	number of grid points in the azimuthal angle
nPhi	number of grid points in the zenithal angle

Member Function Documentation

template<typename U >

virtual void hpp::GridOrientationGenerator< U >::generateNext ( EulerAngles< U > &  angles )

inlinevirtual

Generate the next orientation in the sequence.

Parameters

angles

the set of angles into which to write the new angles

Template Parameters

U	the scalar type

Reimplemented from hpp::OrientationGenerator< U >.

template<typename U >

virtual void hpp::GridOrientationGenerator< U >::generateNext ( Tensor2< U > &  rotMatrix )

inlinevirtual

Generate the next orientation in the sequence.

Parameters

rotMatrix

the matrix into which to write the new rotation matrix

Template Parameters

U	the scalar type

Implements hpp::OrientationGenerator< U >.

Member Data Documentation

template<typename U >

U hpp::GridOrientationGenerator< U >::dPhi

private

the spacing between zenithal angles on the grid

template<typename U >

U hpp::GridOrientationGenerator< U >::dTheta

private

the spacing between azimuthal angles on the grid

template<typename U >

int hpp::GridOrientationGenerator< U >::iPhi = 0

private

the zenithal index of the orientation to generate next

template<typename U >

int hpp::GridOrientationGenerator< U >::iTheta = 0

private

the azimuthal index of the orientation to generate next

template<typename U >

int hpp::GridOrientationGenerator< U >::nPhi

private

the number of grid points for the zenithal angle

template<typename U >

int hpp::GridOrientationGenerator< U >::nTheta

private

the number of grid points for the azimuthal angle

---

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

• /home/mmalahe/projects/hpp/code/include/hpp/casesUtils.h
• /home/mmalahe/projects/hpp/code/src/casesUtils.cpp