Spectral::Swsh::SpinWeightedSphericalHarmonic Class Reference

A utility for evaluating a particular spin-weighted spherical harmonic function at arbitrary points. More...

#include <SwshInterpolation.hpp>

Public Member Functions
	SpinWeightedSphericalHarmonic (int spin, size_t l, int m)
void	evaluate (gsl::not_null< ComplexDataVector * > result, const DataVector &theta, const DataVector &phi, const DataVector &sin_theta_over_2, const DataVector &cos_theta_over_2) const
ComplexDataVector	evaluate (const DataVector &theta, const DataVector &phi, const DataVector &sin_theta_over_2, const DataVector &cos_theta_over_2) const
	Return by value the spin-weighted spherical harmonic evaluated at theta and phi. More...
std::complex< double >	evaluate (double theta, double phi) const
	Return by value the spin-weighted spherical harmonic evaluated at theta and phi.
void	pup (PUP::er &p)
	Serialization for Charm++.

Detailed Description

A utility for evaluating a particular spin-weighted spherical harmonic function at arbitrary points.

Warning

This should NOT be used for interpolation; such an evaluation strategy is hopelessly slow compared to Clenshaw recurrence strategies. Instead use SwshInterpolator.

Member Function Documentation

evaluate() [1/2]

ComplexDataVector Spectral::Swsh::SpinWeightedSphericalHarmonic::evaluate	(	const DataVector &	theta,
		const DataVector &	phi,
		const DataVector &	sin_theta_over_2,
		const DataVector &	cos_theta_over_2
	)		const

Return by value the spin-weighted spherical harmonic evaluated at theta and phi.

Details

The additional values sin_theta_over_2 and cos_theta_over_2, representing $\sin \left(\theta /2\right)$ and $\cos \left(\theta /2\right)$ are taken as required input to improve the speed of evaluation when called more than once.

evaluate() [2/2]

void Spectral::Swsh::SpinWeightedSphericalHarmonic::evaluate	(	gsl::not_null< ComplexDataVector * >	result,
		const DataVector &	theta,
		const DataVector &	phi,
		const DataVector &	sin_theta_over_2,
		const DataVector &	cos_theta_over_2
	)		const

Return by pointer the values of the spin-weighted spherical harmonic evaluated at theta and phi.

Details

The additional values sin_theta_over_2 and cos_theta_over_2, representing $\sin \left(\theta /2\right)$ and $\cos \left(\theta /2\right)$ are taken as required input to improve the speed of evaluation when called more than once.

The formula we evaluate (with various prefactors precomputed, cached, and optimized from the factorials) is [84]

$$\begin{array}{r}{}_s{Y}_{lm}=(-1{)}^m\sqrt{\frac{(l+m)!(l-m)!(2l+1)}{4\pi (l+s)!(l-s)!}}{\sin }^{2l}(\theta /2)\sum _{r=0}^{l-s}(\genfrac{}{}{0ex}{}{l-s}{r})(\genfrac{}{}{0ex}{}{l+s}{r+s-m})(-1{)}^{l-r-s}{e}^{im\varphi }{\cot }^{2r+s-m}(\theta /2).\end{array}$$

---

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

• src/NumericalAlgorithms/SpinWeightedSphericalHarmonics/SwshInterpolation.hpp