GeometricUtilities::Coordinates Namespace Reference

Functions
template<int dim>
std::array< double, dim >	to_spherical (const Point< dim > &point)
template<std::size_t dim>
Point< dim >	from_spherical (const std::array< double, dim > &scoord)
static ::ExceptionBase &	NegativeRadius (double arg1)
static ::ExceptionBase &	SphericalAzimuth (double arg1)
static ::ExceptionBase &	SphericalPolar (double arg1)
template Point< 1 >	from_spherical< 1 > (const std::array< double, 1 > &)
template std::array< double, 1 >	to_spherical< 1 > (const Point< 1 > &)
template Point< 2 >	from_spherical< 2 > (const std::array< double, 2 > &)
template std::array< double, 2 >	to_spherical< 2 > (const Point< 2 > &)
template Point< 3 >	from_spherical< 3 > (const std::array< double, 3 > &)
template std::array< double, 3 >	to_spherical< 3 > (const Point< 3 > &)

Detailed Description

A namespace for coordinate transformations.

Function Documentation

to_spherical()

template<int dim>

std::array< double, dim > GeometricUtilities::Coordinates::to_spherical

(

const Point< dim > &

point

)

Return spherical coordinates of a Cartesian point point. The returned array is filled with radius, azimuth angle \(\in [0,2 \pi)\) and polar/inclination angle \( \in [0,\pi]\) (omitted in 2D).

In 3D the transformation is given by

\begin{align*} r &= \sqrt{x^2+y^2+z^2} \\ \theta &= {\rm atan}(y/x) \\ \phi &= {\rm acos} (z/r) \end{align*}

Definition at line 43 of file geometric_utilities.cc.

from_spherical()

template<std::size_t dim>

Point< dim > GeometricUtilities::Coordinates::from_spherical

(

const std::array< double, dim > &

scoord

)

Return the Cartesian coordinates of a spherical point defined by scoord which is filled with radius \(r \in [0,\infty)\), azimuth angle \(\theta \in [0,2 \pi)\) and polar/inclination angle \(\phi \in [0,\pi]\) (omitted in 2D).

In 3D the transformation is given by

\begin{align*} x &= r\, \cos(\theta) \, \sin(\phi) \\ y &= r\, \sin(\theta) \, \sin(\phi) \\ z &= r\, \cos(\phi) \end{align*}

Definition at line 69 of file geometric_utilities.cc.

from_spherical< 1 >()

template Point< 1 > GeometricUtilities::Coordinates::from_spherical< 1 >

(

const std::array< double, 1 > &

)

to_spherical< 1 >()

template std::array<double, 1 > GeometricUtilities::Coordinates::to_spherical< 1 >

(

const Point< 1 > &

)

from_spherical< 2 >()

template Point< 2 > GeometricUtilities::Coordinates::from_spherical< 2 >

(

const std::array< double, 2 > &

)

to_spherical< 2 >()

template std::array<double, 2 > GeometricUtilities::Coordinates::to_spherical< 2 >

(

const Point< 2 > &

)

from_spherical< 3 >()

template Point< 3 > GeometricUtilities::Coordinates::from_spherical< 3 >

(

const std::array< double, 3 > &

)

to_spherical< 3 >()

template std::array<double, 3 > GeometricUtilities::Coordinates::to_spherical< 3 >

(

const Point< 3 > &

)