CSphericalHarmonicExpansion< TObj > Class Template Reference

#include <harmonic_expansion.h>

Inheritance diagram for CSphericalHarmonicExpansion< TObj >:
[legend]
Collaboration diagram for CSphericalHarmonicExpansion< TObj >:
[legend]

List of all members.

Public Types

typedef
CSphericalHarmonicExpansion
< TObj >::iterator 
term_iterator
typedef
CSphericalHarmonicExpansion
< TObj >::const_iterator 
const_term_iterator

Public Member Functions

 CSphericalHarmonicExpansion (void)
 CSphericalHarmonicExpansion (int _lmax, bool _skip, string _sd=".", string _fp="term")
 ~CSphericalHarmonicExpansion (void)
virtual bool readTerms (void)
 Read terms from disk.
bool fillTerms (void)
 Fill out the list with pre-initialized, but empty, terms.
double_complex getValueSphr (int l, int m, double r)
 get complex value of term w/ lm, specific r
double_complex getErrorSphr (int l, int m, double r)
 get complex uncertainty of term w/ lm, specific r
term_iterator find (int l, int m, bool rpart)
 find a term in the map, return an iterator
TObj & getItem (int l, int m, bool rpart)
TObj & operator() (int l, int m, bool rpart)
TObj getItem (int l, int m, bool rpart) const
TObj operator() (int l, int m, bool rpart) const


Detailed Description

template<class TObj>
class CSphericalHarmonicExpansion< TObj >

For Spherical Harmonic expansion, add some simple functions to interface

Definition at line 236 of file harmonic_expansion.h.


Member Typedef Documentation

template<class TObj>
typedef CSphericalHarmonicExpansion< TObj >::const_iterator CSphericalHarmonicExpansion< TObj >::const_term_iterator

template<class TObj>
typedef CSphericalHarmonicExpansion< TObj >::iterator CSphericalHarmonicExpansion< TObj >::term_iterator


Constructor & Destructor Documentation

template<class TObj>
CSphericalHarmonicExpansion< TObj >::CSphericalHarmonicExpansion ( void   )  [inline]

Definition at line 244 of file harmonic_expansion.h.

template<class TObj>
CSphericalHarmonicExpansion< TObj >::CSphericalHarmonicExpansion ( int  _lmax,
bool  _skip,
string  _sd = ".",
string  _fp = "term" 
) [inline]

Definition at line 245 of file harmonic_expansion.h.

template<class TObj>
CSphericalHarmonicExpansion< TObj >::~CSphericalHarmonicExpansion ( void   )  [inline]

Definition at line 247 of file harmonic_expansion.h.


Member Function Documentation

template<class TObj>
bool CSphericalHarmonicExpansion< TObj >::fillTerms ( void   )  [inline, virtual]

Fill out the list with pre-initialized, but empty, terms.

Implements CHarmonicExpansion< CSphericalHarmonicBasisFunction, TObj >.

Definition at line 287 of file harmonic_expansion.h.

template<class TObj>
term_iterator CSphericalHarmonicExpansion< TObj >::find ( int  l,
int  m,
bool  rpart 
) [inline]

find a term in the map, return an iterator

Definition at line 342 of file harmonic_expansion.h.

template<class TObj>
double_complex CSphericalHarmonicExpansion< TObj >::getErrorSphr ( int  l,
int  m,
double  r 
) [inline]

get complex uncertainty of term w/ lm, specific r

Definition at line 327 of file harmonic_expansion.h.

template<class TObj>
TObj CSphericalHarmonicExpansion< TObj >::getItem ( int  l,
int  m,
bool  rpart 
) const [inline]

Definition at line 354 of file harmonic_expansion.h.

template<class TObj>
TObj& CSphericalHarmonicExpansion< TObj >::getItem ( int  l,
int  m,
bool  rpart 
) [inline]

must pick favorite interface. Note: this is going to throw an error if it can't find the term

Definition at line 350 of file harmonic_expansion.h.

template<class TObj>
double_complex CSphericalHarmonicExpansion< TObj >::getValueSphr ( int  l,
int  m,
double  r 
) [inline]

get complex value of term w/ lm, specific r

Definition at line 312 of file harmonic_expansion.h.

template<class TObj>
TObj CSphericalHarmonicExpansion< TObj >::operator() ( int  l,
int  m,
bool  rpart 
) const [inline]

Definition at line 356 of file harmonic_expansion.h.

template<class TObj>
TObj& CSphericalHarmonicExpansion< TObj >::operator() ( int  l,
int  m,
bool  rpart 
) [inline]

Definition at line 352 of file harmonic_expansion.h.

template<class TObj>
virtual bool CSphericalHarmonicExpansion< TObj >::readTerms ( void   )  [inline, virtual]

Read terms from disk.

Reimplemented from CObject3d.

Definition at line 251 of file harmonic_expansion.h.


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

Generated on Fri Feb 6 13:30:18 2009 for CorAL by  doxygen 1.5.8