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

This class saves coordinates of the resulting point after rotation in the output field. More...

#include <frameChangeF3D.h>

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

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

Public Member Functions
	RotationRoundAxis3D (olb::Vector< T, 3 > origin, olb::Vector< T, 3 > rotAxisDirection, T alpha)
	constructor defines _rotAxisDirection, _alpha and _origin
bool	operator() (T output[], const S x[]) override
	operator writes coordinates of the resulting point after rotation of x by angle _alpha in math positive sense to _rotAxisDirection with _origin into 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
olb::Vector< T, 3 >	_origin
	origin, around which x is turned
olb::Vector< T, 3 >	_rotAxisDirection
	direction, around which x is turned
T	_alpha
	angle, by which vector x is rotated around _rotAxisDirection

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::RotationRoundAxis3D< T, S >

This class saves coordinates of the resulting point after rotation in the output field.

The resulting point is achieved after rotation of x with angle _alpha in math positive sense relative to _rotAxisDirection with a given _origin.

Definition at line 356 of file frameChangeF3D.h.

Constructor & Destructor Documentation

RotationRoundAxis3D()

template<typename T , typename S >

olb::RotationRoundAxis3D< T, S >::RotationRoundAxis3D	(	olb::Vector< T, 3 >	origin,
		olb::Vector< T, 3 >	rotAxisDirection,
		T	alpha )

constructor defines _rotAxisDirection, _alpha and _origin

Definition at line 836 of file frameChangeF3D.hh.

  : AnalyticalF3D<T, S>(3),
    _origin(origin),
    _rotAxisDirection(rotAxisDirection),
    _alpha(alpha)
{
  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::RotationRoundAxis3D< T, S >::operator() ( T output[], const S x[] )

overridevirtual

operator writes coordinates of the resulting point after rotation of x by angle _alpha in math positive sense to _rotAxisDirection with _origin into output field

Implements olb::GenericF< T, S >.

Definition at line 849 of file frameChangeF3D.hh.

{
  Vector<T, 3> n(_rotAxisDirection);
  if ( !util::nearZero(norm(n)) && norm(n) > 0 ) {
    //std::cout<< "Rotation axis: " << _rotAxisDirection[0] << " " << _rotAxisDirection[1] << " " << _rotAxisDirection[2] << std::endl;
    n = normalize(n);
    // translation
    Vector<T, 3> x_tmp;
    for (int i = 0; i < 3; ++i) {
      x_tmp[i] = x[i] - _origin[i];
    }
    // rotation
    output[0] = (n[0]*n[0]*(1 - util::cos(_alpha)) + util::cos(_alpha)) * x_tmp[0]
                + (n[0]*n[1]*(1 - util::cos(_alpha)) - n[2]*util::sin(_alpha))*x_tmp[1]
                + (n[0]*n[2]*(1 - util::cos(_alpha)) + n[1]*util::sin(_alpha))*x_tmp[2]
                + _origin[0];
 
    output[1] = (n[1]*n[0]*(1 - util::cos(_alpha)) + n[2]*util::sin(_alpha))*x_tmp[0]
                + (n[1]*n[1]*(1 - util::cos(_alpha)) + util::cos(_alpha))*x_tmp[1]
                + (n[1]*n[2]*(1 - util::cos(_alpha)) - n[0]*util::sin(_alpha))*x_tmp[2]
                + _origin[1];
 
    output[2] = (n[2]*n[0]*(1 - util::cos(_alpha)) - n[1]*util::sin(_alpha))*x_tmp[0]
                + (n[2]*n[1]*(1 - util::cos(_alpha)) + n[0]*util::sin(_alpha))*x_tmp[1]
                + (n[2]*n[2]*(1 - util::cos(_alpha)) + util::cos(_alpha))*x_tmp[2]
                + _origin[2];
    return true;
  }
  else {
    //std::cout<< "Axis is null or NaN" <<std::endl;
    for (int j=0; j<3; j++) {
      output[j] = x[j];
    }
    return true;
  }
}

References olb::util::cos(), olb::util::nearZero(), olb::norm(), olb::normalize(), and olb::util::sin().

Here is the call graph for this function:

Member Data Documentation

_alpha

template<typename T , typename S >

T olb::RotationRoundAxis3D< T, S >::_alpha

protected

angle, by which vector x is rotated around _rotAxisDirection

Definition at line 363 of file frameChangeF3D.h.

_origin

template<typename T , typename S >

olb::Vector<T, 3> olb::RotationRoundAxis3D< T, S >::_origin

protected

origin, around which x is turned

Definition at line 359 of file frameChangeF3D.h.

_rotAxisDirection

template<typename T , typename S >

olb::Vector<T, 3> olb::RotationRoundAxis3D< T, S >::_rotAxisDirection

protected

direction, around which x is turned

Definition at line 361 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