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

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

#include <frameChangeF3D.h>

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

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

Public Member Functions
	CartesianToSpherical3D (std::vector< T > cartesianOrigin, std::vector< T > axisDirection)
bool	operator() (T output[], const S x[]) override
	operator writes shperical coordinates of Cartesian point x into output field, output[0] = radius ( >= 0), output[1] = phi (in [0, 2Pi)), output[2] = theta (in [0, Pi])
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 >	_cartesianOrigin
	origin of the Cartesian coordinate system
std::vector< T >	_axisDirection
	direction of the axis along which the spherical coordinates are calculated

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

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

Initial situation for the spherical coordinate system is that angle phi lies in x-y-plane and theta in x-z-plane. The z axis is the orientation for the mathematical positive sense of phi.

Definition at line 511 of file frameChangeF3D.h.

Constructor & Destructor Documentation

CartesianToSpherical3D()

template<typename T , typename S >

olb::CartesianToSpherical3D< T, S >::CartesianToSpherical3D	(	std::vector< T >	cartesianOrigin,
		std::vector< T >	axisDirection )

Definition at line 1115 of file frameChangeF3D.hh.

  : AnalyticalF3D<T, S>(3),
    _cartesianOrigin(cartesianOrigin),
    _axisDirection(axisDirection)
{
  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::CartesianToSpherical3D< T, S >::operator() ( T output[], const S x[] )

overridevirtual

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

Implements olb::GenericF< T, S >.

Definition at line 1127 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];
 
  Vector<T,3> axisDirection(_axisDirection);
  Vector<T,3> e3(T(), T(), T(1));
  Vector<T,3> normal = crossProduct3D(axisDirection,e3);
 
  Vector<T,3> normalAxisDir = axisDirection;
  normalAxisDir = normalize(normalAxisDir);
  Vector<T,3> cross;
  // if axis has to be rotated
  if ( !( util::nearZero(normalAxisDir[0]) && util::nearZero(normalAxisDir[1]) && util::nearZero(normalAxisDir[2]-1) ) ) {
    AngleBetweenVectors3D<T, S> angle(util::fromVector3(e3), util::fromVector3(normal));
    T tmp[3] = {T(),T(),T()};
    for (int i=0; i<3; ++i) {
      tmp[i] = axisDirection[i];
    }
    T alpha[1] = {T(0)};
    angle(alpha,tmp);
    // cross is rotation axis
    cross = crossProduct3D(e3, axisDirection);
    // 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), util::fromVector3(cross));
  //  y[0] = car2pol(x_rot)[0];
  Vector<T, 3> difference;
 
  for (int i=0; i<3; ++i) {
    difference[i] = x_rot[i] - _cartesianOrigin[i];
  }
 
  T distance = T();
  for (int i = 0; i <= 2; ++i) {
    distance += difference[i]*difference[i];
  }
  distance = util::sqrt(distance);
 
  car2pol(output, x_rot);
  output[0] = distance;
  output[2] = util::acos(difference[2]/output[0]);  // angle between z-axis and r-vector
 
  return true;  // output[0] = radius, output[1] = phi, output[2] = theta
}

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

Here is the call graph for this function:

Member Data Documentation

_axisDirection

template<typename T , typename S >

std::vector<T> olb::CartesianToSpherical3D< T, S >::_axisDirection

protected

direction of the axis along which the spherical coordinates are calculated

Definition at line 516 of file frameChangeF3D.h.

_cartesianOrigin

template<typename T , typename S >

std::vector<T> olb::CartesianToSpherical3D< T, S >::_cartesianOrigin

protected

origin of the Cartesian coordinate system

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