Reduced spherical harmonics. More...

#include <maths.hpp>

Static Public Member Functions
static std::complex< double >	calc_reduced_spherical_harmonic (const int ell, const int m, double pos[3])
	Calculate the reduced spherical harmonic.

static void	store_reduced_spherical_harmonic_in_fourier_space (const int ell, const int m, const double boxsize[3], const int ngrid[3], std::vector< std::complex< double > > &ylm_out)
	Store reduced spherical harmonics computed in Fourier space.

static void	store_reduced_spherical_harmonic_in_config_space (const int ell, const int m, const double boxsize[3], const int ngrid[3], std::vector< std::complex< double > > &ylm_out)
	Store reduced spherical harmonics computed in configuration space.

Detailed Description

Reduced spherical harmonics.

The 'reduced' (conjugated and unit normalised) spherical harmonics are given by

\[ y_\ell^m = \sqrt{\frac{4\pi}{2\ell + 1}} {Y_\ell^m}^\ast \]

with \( y_0^0 = 1 \).

Definition at line 208 of file maths.hpp.

Member Function Documentation

std::complex< double > trv::maths::SphericalHarmonicCalculator::calc_reduced_spherical_harmonic	(	const int	ell,
		const int	m,
		double	pos[3] )

static

Calculate the reduced spherical harmonic.

Parameters

Definition at line 172 of file maths.cpp.

Here is the caller graph for this function:

void trv::maths::SphericalHarmonicCalculator::store_reduced_spherical_harmonic_in_fourier_space	(	const int	ell,
		const int	m,
		const double	boxsize[3],
		const int	ngrid[3],
		std::vector< std::complex< double > > &	ylm_out )

static

Store reduced spherical harmonics computed in Fourier space.

Parameters

[in]	ell	Degree \( \ell \).
[in]	m	Order \( m \).
[in]	boxsize	Box size in each dimension.
[in]	ngrid	Grid cell number in each dimension.
[out]	ylm_out	Stored \( y_\ell^m \) values.

Exceptions

trv::sys::InvalidDataError When the output variable is not provided.

Definition at line 222 of file maths.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void trv::maths::SphericalHarmonicCalculator::store_reduced_spherical_harmonic_in_config_space	(	const int	ell,
		const int	m,
		const double	boxsize[3],
		const int	ngrid[3],
		std::vector< std::complex< double > > &	ylm_out )

static

Store reduced spherical harmonics computed in configuration space.

Parameters

[in]	ell	Degree \( \ell \).
[in]	m	Order \( m \).
[in]	boxsize	Box size in each dimension.
[in]	ngrid	Grid cell number in each dimension.
[out]	ylm_out	Stored \( y_\ell^m \) values.

Exceptions

trv::sys::InvalidDataError When the output variable is not provided.

Definition at line 262 of file maths.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

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

/home/docs/checkouts/readthedocs.org/user_builds/triumvirate/checkouts/latest/src/triumvirate/include/maths.hpp
/home/docs/checkouts/readthedocs.org/user_builds/triumvirate/checkouts/latest/src/triumvirate/src/maths.cpp