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

This class converts Cartesian coordinates of point x to cylindrical coordinates wrote into output field (output[0] = radius, output[1] = phi, output[2] = z). More...

#include <frameChangeF3D.h>

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

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

Public Member Functions
	CartesianToCylinder3D (olb::Vector< T, 3 > cartesianOrigin, T &angle, olb::Vector< T, 3 > orientation={T(1), T(), T()})
	CartesianToCylinder3D (olb::Vector< T, 3 > cartesianOrigin, olb::Vector< T, 3 > axisDirection, olb::Vector< T, 3 > orientation={T(1), T(), T()})
	CartesianToCylinder3D (T cartesianOriginX, T cartesianOriginY, T cartesianOriginZ, T axisDirectionX, T axisDirectionY, T axisDirectionZ, T orientationX=T(1), T orientationY=T(), T orientationZ=T())
bool	operator() (T output[], const S x[]) override
	operator writes cylindrical coordinates of Cartesian point x into output field, output[0] = radius ( >= 0), output[1] = phi (in [0, 2Pi)), output[2] = z
olb::Vector< T, 3 > const &	getAxisDirection () const
	Read only access to _axisDirection.
olb::Vector< T, 3 > &	getAxisDirection ()
	Read and write access to _axisDirection.
olb::Vector< T, 3 > const &	getCartesianOrigin () const
	Read only access to _catesianOrigin.
olb::Vector< T, 3 > &	getCartesianOrigin ()
	Read and write access to _catesianOrigin.
void	setAngle (T angle)
	Read and write access to _axisDirection using angle.
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 >	_cartesianOrigin
	origin of the Cartesian coordinate system
olb::Vector< T, 3 >	_axisDirection
	direction of the axis along which the cylindrical coordinates are calculated
olb::Vector< T, 3 >	_orientation
	direction to know orientation for math positive to obtain angle phi of Cartesian point x

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

This class converts Cartesian coordinates of point x to cylindrical coordinates wrote into output field (output[0] = radius, output[1] = phi, output[2] = z).

Initial situation for the cylindrical coordinate system is that angle phi lies in plane perpendicular to the _axisDirection and turns around the _cartesianOrigin. The radius is the distance of point x to the _axisDirection and z the distance to _cartesianOrigin along _axisDirection.

Definition at line 443 of file frameChangeF3D.h.

Constructor & Destructor Documentation

CartesianToCylinder3D() [1/3]

template<typename T , typename S >

olb::CartesianToCylinder3D< T, S >::CartesianToCylinder3D	(	olb::Vector< T, 3 >	cartesianOrigin,
		T &	angle,
		olb::Vector< T, 3 >	orientation = {T(1),T(),T()} )

Definition at line 942 of file frameChangeF3D.hh.

  : AnalyticalF3D<T, S>(3),
    _cartesianOrigin(cartesianOrigin),
    _orientation(orientation)
{
  // rotation with angle to (0,0,1)
  std::vector<T> origin(3,T());
  T e3[3]= {T(),T(),T()};
  e3[2] = T(1);
  RotationRoundAxis3D<T, S> rotRAxis(origin, orientation, angle);
  T tmp[3] = {T(),T(),T()};
  rotRAxis(tmp, e3);
 
  std::vector<T> htmp(tmp,tmp+3);
  _axisDirection = htmp;
}

References olb::CartesianToCylinder3D< T, S >::_axisDirection.

CartesianToCylinder3D() [2/3]

template<typename T , typename S >

olb::CartesianToCylinder3D< T, S >::CartesianToCylinder3D	(	olb::Vector< T, 3 >	cartesianOrigin,
		olb::Vector< T, 3 >	axisDirection,
		olb::Vector< T, 3 >	orientation = {T(1),T(),T()} )

Definition at line 962 of file frameChangeF3D.hh.

  : AnalyticalF3D<T, S>(3),
    _cartesianOrigin(cartesianOrigin),
    _axisDirection(axisDirection),
    _orientation(orientation)
{
  this->getName() = "const";
}

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

Here is the call graph for this function:

CartesianToCylinder3D() [3/3]

template<typename T , typename S >

olb::CartesianToCylinder3D< T, S >::CartesianToCylinder3D	(	T	cartesianOriginX,
		T	cartesianOriginY,
		T	cartesianOriginZ,
		T	axisDirectionX,
		T	axisDirectionY,
		T	axisDirectionZ,
		T	orientationX = T(1),
		T	orientationY = T(),
		T	orientationZ = T() )

Definition at line 975 of file frameChangeF3D.hh.

  : AnalyticalF3D<T, S>(3)
{
  _cartesianOrigin[0] = cartesianOriginX;
  _cartesianOrigin[1] = cartesianOriginY;
  _cartesianOrigin[2] = cartesianOriginZ;
 
  _axisDirection[0] = axisDirectionX;
  _axisDirection[1] = axisDirectionY;
  _axisDirection[2] = axisDirectionZ;
 
  _orientation[0] = orientationX;
  _orientation[1] = orientationY;
  _orientation[2] = orientationZ;
}

References olb::CartesianToCylinder3D< T, S >::_axisDirection, olb::CartesianToCylinder3D< T, S >::_cartesianOrigin, and olb::CartesianToCylinder3D< T, S >::_orientation.

Member Function Documentation

getAxisDirection() [1/2]

template<typename T , typename S >

olb::Vector< T, 3 > & olb::CartesianToCylinder3D< T, S >::getAxisDirection

(

)

Read and write access to _axisDirection.

Definition at line 1053 of file frameChangeF3D.hh.

{
  return _axisDirection;
}

getAxisDirection() [2/2]

template<typename T , typename S >

olb::Vector< T, 3 > const & olb::CartesianToCylinder3D< T, S >::getAxisDirection

(

)

const

Read only access to _axisDirection.

Definition at line 1046 of file frameChangeF3D.hh.

{
  return _axisDirection;
}

getCartesianOrigin() [1/2]

template<typename T , typename S >

olb::Vector< T, 3 > & olb::CartesianToCylinder3D< T, S >::getCartesianOrigin

(

)

Read and write access to _catesianOrigin.

Definition at line 1067 of file frameChangeF3D.hh.

{
  return _cartesianOrigin;
}

getCartesianOrigin() [2/2]

template<typename T , typename S >

olb::Vector< T, 3 > const & olb::CartesianToCylinder3D< T, S >::getCartesianOrigin

(

)

const

Read only access to _catesianOrigin.

Definition at line 1060 of file frameChangeF3D.hh.

{
  return _cartesianOrigin;
}

operator()()

template<typename T , typename S >

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

overridevirtual

operator writes cylindrical coordinates of Cartesian point x into output field, output[0] = radius ( >= 0), output[1] = phi (in [0, 2Pi)), output[2] = z

Implements olb::GenericF< T, S >.

Definition at line 997 of file frameChangeF3D.hh.

{
  T x_rot[3] = {T(),T(),T()};
  x_rot[0] = x[0];
  x_rot[1] = x[1];
  x_rot[2] = x[2];
//  T x_rot[3] = {x[0], x[1], x[2]};
  Vector<T, 3> e3(T(),T(), T(1));
  Vector<T, 3> axisDirection(_axisDirection);
  Vector<T, 3> orientation(_orientation);
 
  Vector<T, 3> normal = crossProduct3D(axisDirection, e3);
  Vector<T, 3> normalAxisDir(axisDirection);
  normalAxisDir = normalize(normalAxisDir);
 
  // if axis has to be rotated
  if (!( util::nearZero(normalAxisDir[0]) && util::nearZero(normalAxisDir[1]) && util::nearZero(normalAxisDir[2]-1) )) {
 
    if ( !util::nearZero(norm(orientation)) ) {
      normal = orientation; // if _orientation = 0,0,0 -> segm. fault
    }
    AngleBetweenVectors3D<T,S> angle(util::fromVector3(e3), util::fromVector3(normal));
    T tmp[3] = {T(),T(),T()};
    tmp[0] = axisDirection[0];
    tmp[1] = axisDirection[1];
    tmp[2] = axisDirection[2];
    T alpha[1] = {T()};
    angle(alpha, tmp);
 
    // rotation with angle alpha to (0,0,1)
    RotationRoundAxis3D<T, S> rotRAxis(_cartesianOrigin, util::fromVector3(normal), -alpha[0]);
    rotRAxis(x_rot, x);
  }
  CartesianToPolar2D<T, S> car2pol(_cartesianOrigin, util::fromVector3(e3), _orientation);
  T x_rot_help[2] = {T(),T()};
  x_rot_help[0] = x_rot[0];
  x_rot_help[1] = x_rot[1];
 
  T output_help[2] = {T(),T()};
  car2pol(output_help, x_rot_help);
 
  output[0] = output_help[0];
  output[1] = output_help[1];
  output[2] = x_rot[2] - _cartesianOrigin[2];
  return true;  // output[0] = radius, output[1] = phi, output[2] = z
}

References olb::crossProduct3D(), olb::util::fromVector3(), olb::util::nearZero(), olb::norm(), and olb::normalize().

Here is the call graph for this function:

setAngle()

template<typename T , typename S >

void olb::CartesianToCylinder3D< T, S >::setAngle

(

T

angle

)

Read and write access to _axisDirection using angle.

Definition at line 1074 of file frameChangeF3D.hh.

{
  std::vector<T> Null(3,T());
  T e3[3] = {T(),T(),T()};
  e3[2] = T(1);
 
  RotationRoundAxis3D<T, S> rotRAxis(Null, _orientation, angle);
  T tmp[3] = {T(),T(),T()};
  rotRAxis(tmp,e3);
  for (int i=0; i<3; ++i) {
    _axisDirection[i] = tmp[i];
  }
}

Member Data Documentation

_axisDirection

template<typename T , typename S >

olb::Vector<T, 3> olb::CartesianToCylinder3D< T, S >::_axisDirection

protected

direction of the axis along which the cylindrical coordinates are calculated

Definition at line 448 of file frameChangeF3D.h.

_cartesianOrigin

template<typename T , typename S >

olb::Vector<T, 3> olb::CartesianToCylinder3D< T, S >::_cartesianOrigin

protected

origin of the Cartesian coordinate system

Definition at line 446 of file frameChangeF3D.h.

_orientation

template<typename T , typename S >

olb::Vector<T, 3> olb::CartesianToCylinder3D< T, S >::_orientation

protected

direction to know orientation for math positive to obtain angle phi of Cartesian point x

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