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

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

#include <frameChangeF3D.h>

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

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

Public Member Functions
	CylinderToCartesian3D (std::vector< T > cylinderOrigin)
	constructor defines _cylinderOrigin
bool	operator() (T output[], const S x[]) override
	operator writes Cartesian coordinates of cylinder coordinates x[0] = radius >= 0, x[1] = phi in [0, 2*Pi), x[2] = z 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
std::vector< T >	_cylinderOrigin

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

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

Initial situation for the Cartesian coordinate system is that angle phi lies in the x-y-plane and turns util::round the _cylinderOrigin, the z-axis direction equals the axis direction of the cylinder.

Definition at line 384 of file frameChangeF3D.h.

Constructor & Destructor Documentation

CylinderToCartesian3D()

template<typename T , typename S >

olb::CylinderToCartesian3D< T, S >::CylinderToCartesian3D

(

std::vector< T >

cylinderOrigin

)

constructor defines _cylinderOrigin

Definition at line 894 of file frameChangeF3D.hh.

  : AnalyticalF3D<T, S>(3),
    _cylinderOrigin(cylinderOrigin)
{
  this->getName() = "CylinderToCartesian3D";
}

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::CylinderToCartesian3D< T, S >::operator() ( T output[], const S x[] )

overridevirtual

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

Implements olb::GenericF< T, S >.

Definition at line 905 of file frameChangeF3D.hh.

{
  PolarToCartesian2D<T, S> pol2cart(_cylinderOrigin);
  pol2cart(output,x);
  output[2] = x[2];
  return true;
}

Member Data Documentation

_cylinderOrigin

template<typename T , typename S >

std::vector<T> olb::CylinderToCartesian3D< T, S >::_cylinderOrigin

protected

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