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

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

#include <frameChangeF3D.h>

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

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

Public Member Functions
	SphericalToCartesian3D ()
bool	operator() (T output[], const S x[]) override
	operator writes spherical coordinates of Cartesian coordinates of x (x[0] = radius, x[1] = phi, x[2] = theta) 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)

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

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

Initial situation for the Cartesian coordinate system is that angle phi (phi in [0, 2Pi)) lies in x-y-plane and turns around the Cartesian origin (0,0,0). Angle theta (theta in [0, Pi]) lies in y-z-plane. z axis equals the _orientation of the spherical coordinate system. The radius is distance of point x to the Cartesian _origin

Definition at line 454 of file frameChangeF3D.h.

Constructor & Destructor Documentation

SphericalToCartesian3D()

template<typename T , typename S >

olb::SphericalToCartesian3D< T, S >::SphericalToCartesian3D

(

)

Definition at line 1068 of file frameChangeF3D.hh.

  : AnalyticalF3D<T, S>(3)  //, _sphericalOrigin(sphericalOrigin)
{
  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::SphericalToCartesian3D< T, S >::operator() ( T output[], const S x[] )

overridevirtual

operator writes spherical coordinates of Cartesian coordinates of x (x[0] = radius, x[1] = phi, x[2] = theta) into output field.

phi is in x-y-plane, theta in x-z-plane, z axis as orientation

Implements olb::GenericF< T, S >.

Definition at line 1079 of file frameChangeF3D.hh.

{
  output[0] = x[0]*util::sin(x[2])*util::cos(x[1]);
  output[1] = x[0]*util::sin(x[2])*util::sin(x[1]);
  output[2] = x[0]*util::cos(x[2]);
  return true;
}

References olb::util::cos(), and olb::util::sin().

Here is the call graph for this function:

---

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

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