Logo coherent WaveBurst  
Library Reference Guide 		Logo
List of all members | Public Member Functions | Protected Attributes | List of all members
wat::Alm_Base Class Reference

Base class for calculating the storage layout of spherical harmonic coefficients.

Definition at line 43 of file alm.hh.

Public Member Functions

 Alm_Base (int lmax_=0, int mmax_=0)
 Constructs an Alm_Base object with given lmax and mmax. More...
 
bool conformable (const Alm_Base &other) const
 Returns true, if both objects have the same lmax and mmax, else false. More...
 
int index (int l, int m) const
 Returns the array index of the specified coefficient. More...
 
int index_l0 (int m) const
 Returns an array index for a given m, from which the index of a_lm can be obtained by adding l. More...
 
int Lmax () const
 Returns the maximum l. More...
 
int Mmax () const
 Returns the maximum m. More...
 
int Num_Alms (int l, int m)
 Returns the total number of coefficients for maximum quantum numbers l and m. More...
 
void Set (int lmax_, int mmax_)
 Changes the object's maximum quantum numbers to lmax and mmax. More...
 
void swap (Alm_Base &other)
 Swaps the contents of two Alm_Base objects. More...
 

Protected Attributes

int lmax
 
int mmax
 
int tval
 

#include <alm.hh>

Inheritance diagram for wat::Alm_Base:
[legend]

Constructor & Destructor Documentation

◆ Alm_Base()

wat::Alm_Base::Alm_Base ( int  lmax_ = 0,
int  mmax_ = 0 
)
inline

Constructs an Alm_Base object with given lmax and mmax.

Definition at line 50 of file alm.hh.

Member Function Documentation

◆ conformable()

bool wat::Alm_Base::conformable ( const Alm_Base &  other) const
inline

Returns true, if both objects have the same lmax and mmax, else false.

Definition at line 85 of file alm.hh.

◆ index()

int wat::Alm_Base::index ( int  l,
int  m 
) const
inline

Returns the array index of the specified coefficient.

Definition at line 80 of file alm.hh.

◆ index_l0()

int wat::Alm_Base::index_l0 ( int  m) const
inline

Returns an array index for a given m, from which the index of a_lm can be obtained by adding l.

Definition at line 76 of file alm.hh.

◆ Lmax()

int wat::Alm_Base::Lmax ( ) const
inline

Returns the maximum l.

Definition at line 70 of file alm.hh.

◆ Mmax()

int wat::Alm_Base::Mmax ( ) const
inline

Returns the maximum m.

Definition at line 72 of file alm.hh.

◆ Num_Alms()

int wat::Alm_Base::Num_Alms ( int  l,
int  m 
)
inline

Returns the total number of coefficients for maximum quantum numbers l and m.

Definition at line 55 of file alm.hh.

◆ Set()

void wat::Alm_Base::Set ( int  lmax_,
int  mmax_ 
)
inline

Changes the object's maximum quantum numbers to lmax and mmax.

Definition at line 62 of file alm.hh.

◆ swap()

void wat::Alm_Base::swap ( Alm_Base &  other)

Swaps the contents of two Alm_Base objects.

Member Data Documentation

◆ lmax

int wat::Alm_Base::lmax
protected

Definition at line 46 of file alm.hh.

◆ mmax

int wat::Alm_Base::mmax
protected

Definition at line 46 of file alm.hh.

◆ tval

int wat::Alm_Base::tval
protected

Definition at line 46 of file alm.hh.

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