namespace ewalena  0.2.15
ewalena is not an acronym
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Private Member Functions
ewalena::SphericalHarmonicFunction< dim, ValueType > Class Template Reference

#include <include/ewalena/numerics/spherical_harmonic_function.h>

List of all members.

Public Member Functions

 SphericalHarmonicFunction ()
ValueType value (const OrbitalType &orbital, Point< dim, ValueType > &p)
 ~SphericalHarmonicFunction ()

Private Member Functions

ValueType l1_value (const int m, Point< dim, ValueType > &p)
ValueType l2_value (const int m, Point< dim, ValueType > &p)

Detailed Description

template<int dim, typename ValueType = double>
class ewalena::SphericalHarmonicFunction< dim, ValueType >

This class returns certain evaluations of real spherical harmonics using the phase convention of COndon and Shortley.

Author:
Toby D. Young 2012.

Constructor & Destructor Documentation

template<int dim, typename ValueType = double>
ewalena::SphericalHarmonicFunction< dim, ValueType >::SphericalHarmonicFunction ( ) [inline]

Constructor.

template<int dim, typename ValueType = double>
ewalena::SphericalHarmonicFunction< dim, ValueType >::~SphericalHarmonicFunction ( )

Destructor.


Member Function Documentation

template<int dim, typename ValueType = double>
ValueType ewalena::SphericalHarmonicFunction< dim, ValueType >::l1_value ( const int  m,
Point< dim, ValueType > &  p 
) [private]

Return the $l=1$ at $m$.

template<int dim, typename ValueType = double>
ValueType ewalena::SphericalHarmonicFunction< dim, ValueType >::l2_value ( const int  m,
Point< dim, ValueType > &  p 
) [private]

Return the $l=2$ at $m$.

template<int dim, typename ValueType = double>
ValueType ewalena::SphericalHarmonicFunction< dim, ValueType >::value ( const OrbitalType orbital,
Point< dim, ValueType > &  p 
)

Return the value of this spherical harmonic with quantum numbers $l,m$ at this point.

Note:
These return the origin-centered spherical harmonics.

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines