olb::AngleBetweenVectors3D< T, S > Class Template Reference

This class calculates the angle alpha between vector _referenceVector and any other vector x. More...

#include <frameChangeF3D.h>

Inheritance diagram for olb::AngleBetweenVectors3D< T, S >:

Collaboration diagram for olb::AngleBetweenVectors3D< T, S >:

Public Member Functions
	AngleBetweenVectors3D (std::vector< T > referenceVector, std::vector< T > orientation)
	constructor defines _referenceVector and _orientation
bool	operator() (T output[], const S x[]) override
	operator writes angle between x and _referenceVector inro output field
Public Member Functions inherited from olb::AnalyticalF< D, T, S >
AnalyticalF< D, T, S > &	operator- (AnalyticalF< D, T, S > &rhs)
AnalyticalF< D, T, S > &	operator+ (AnalyticalF< D, T, S > &rhs)
AnalyticalF< D, T, S > &	operator* (AnalyticalF< D, T, S > &rhs)
AnalyticalF< D, T, S > &	operator/ (AnalyticalF< D, T, S > &rhs)
Public Member Functions inherited from olb::GenericF< T, S >
virtual	~GenericF ()=default
int	getSourceDim () const
	read only access to member variable _m
int	getTargetDim () const
	read only access to member variable _n
std::string &	getName ()
	read and write access to name
std::string const &	getName () const
	read only access to name
bool	operator() (T output[])
	wrapper that call the pure virtual operator() (T output[], const S input[]) from above
bool	operator() (T output[], S input0)
bool	operator() (T output[], S input0, S input1)
bool	operator() (T output[], S input0, S input1, S input2)
bool	operator() (T output[], S input0, S input1, S input2, S input3)

Protected Attributes
std::vector< T >	_referenceVector
	between _referenceVector and vector x, angle is calculated
std::vector< T >	_orientation
	direction around which x has to be turned with angle is in math pos sense to lie over _referenceVector

Additional Inherited Members
Public Types inherited from olb::AnalyticalF< D, T, S >
using	identity_functor_type = AnalyticalIdentity<D,T,S>
Public Types inherited from olb::GenericF< T, S >
using	targetType = T
using	sourceType = S
Public Attributes inherited from olb::GenericF< T, S >
std::shared_ptr< GenericF< T, S > >	_ptrCalcC
	memory management, frees resouces (calcClass)
Static Public Attributes inherited from olb::AnalyticalF< D, T, S >
static constexpr unsigned	dim = D
Protected Member Functions inherited from olb::AnalyticalF< D, T, S >
	AnalyticalF (int n)
Protected Member Functions inherited from olb::GenericF< T, S >
	GenericF (int targetDim, int sourceDim)

Detailed Description

template<typename T, typename S>
class olb::AngleBetweenVectors3D< T, S >

This class calculates the angle alpha between vector _referenceVector and any other vector x.

Vector x has to be turned by alpha in mathematical positive sense depending to _orientation to lie over vector _referenceVector

Definition at line 335 of file frameChangeF3D.h.

Constructor & Destructor Documentation

AngleBetweenVectors3D()

template<typename T , typename S >

olb::AngleBetweenVectors3D< T, S >::AngleBetweenVectors3D	(	std::vector< T >	referenceVector,
		std::vector< T >	orientation )

constructor defines _referenceVector and _orientation

Definition at line 760 of file frameChangeF3D.hh.

  : AnalyticalF3D<T, S>(1),
    _referenceVector(referenceVector),
    _orientation(orientation)
{
  this->getName() = "const";
}

References olb::GenericF< T, S >::getName().

Here is the call graph for this function:

Member Function Documentation

operator()()

template<typename T , typename S >

bool olb::AngleBetweenVectors3D< T, S >::operator() ( T output[], const S x[] )

overridevirtual

operator writes angle between x and _referenceVector inro output field

Implements olb::GenericF< T, S >.

Definition at line 771 of file frameChangeF3D.hh.

{
  Vector<T, 3> n_x;
  Vector<T, 3> orientation(_orientation);
  T angle = T(0);
 
  if ( util::nearZero(x[0]) && util::nearZero(x[1]) && util::nearZero(x[2]) ) {
    // if (util::abs(x[0]) + util::abs(x[1]) + util::abs(x[2]) == T()) {
    output[0] = angle;  // angle = 0
    return true;
  }
  else {
    //Vector<S, 3> x_tmp(x); // check construction
    n_x[0] = x[0];
    n_x[1] = x[1];
    n_x[2] = x[2];
    n_x = normalize(n_x);
  }
 
  Vector<T, 3> n_ref(_referenceVector);
  n_ref = normalize(n_ref);
  Vector<T, 3> cross = crossProduct3D(n_x, n_ref);
  T n_dot = n_x * n_ref;
 
 
  if ( util::nearZero(cross*orientation) ) {
    // std::cout<< "orientation in same plane as x and refvector" << std::endl;
  }
  // angle = Pi, if n_x, n_ref opposite
  if ( util::nearZero(n_x[0]+n_ref[0]) && util::nearZero(n_x[1]+n_ref[1]) && util::nearZero(n_x[2]+n_ref[2]) ) {
    angle = util::acos(-1);
  }
  // angle = 0, if n_x, n_ref equal
  else if ( util::nearZero(n_x[0]-n_ref[0]) && util::nearZero(n_x[1]-n_ref[1]) && util::nearZero(n_x[2]-n_ref[2]) ) {
    angle = T();
  }
  // angle in (0,Pi) or (Pi,2Pi), if n_x, n_ref not opposite or equal
  else {
    Vector<T, 3> n_cross(cross);
    n_cross = normalize(n_cross);
    T normal = norm(cross);
    Vector<T, 3> n_orient;
 
    if ( !util::nearZero(norm(orientation)) ) {
      n_orient = orientation;
      n_orient = normalize(n_orient);
    }
    else {
      std::cout << "orientation vector does not fit" << std::endl;
    }
    if ((cross * orientation) > T()) {
      angle = 2*M_PI - util::atan2(normal, n_dot);
    }
    if ((cross * orientation) < T()) {
      angle = util::atan2(normal, n_dot);
    }
  }
  output[0] = angle;
  return true;
}

References olb::util::acos(), olb::util::atan2(), olb::crossProduct3D(), M_PI, olb::util::nearZero(), olb::norm(), and olb::normalize().

Here is the call graph for this function:

Member Data Documentation

_orientation

template<typename T , typename S >

std::vector<T> olb::AngleBetweenVectors3D< T, S >::_orientation

protected

direction around which x has to be turned with angle is in math pos sense to lie over _referenceVector

Definition at line 341 of file frameChangeF3D.h.

_referenceVector

template<typename T , typename S >

std::vector<T> olb::AngleBetweenVectors3D< T, S >::_referenceVector

protected

between _referenceVector and vector x, angle is calculated

Definition at line 338 of file frameChangeF3D.h.

---

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

• src/functors/analytical/frameChangeF3D.h
• src/functors/analytical/frameChangeF3D.hh