CHarmonicExpansion< TBas, TObj > Class Template Reference

#include <harmonic_expansion.h>

Inheritance diagram for CHarmonicExpansion< TBas, TObj >:
[legend]
Collaboration diagram for CHarmonicExpansion< TBas, TObj >:
[legend]

List of all members.

Public Types

typedef CHarmonicExpansion
< TBas, TObj >::iterator 
term_iterator
typedef CHarmonicExpansion
< TBas, TObj >::const_iterator 
const_term_iterator

Public Member Functions

 CHarmonicExpansion (void)
 CHarmonicExpansion (int _lmax, bool _skip, string _sd, string _fp="term")
virtual ~CHarmonicExpansion (void)
bool Read (const parameterMap &s)
 Read from parameterMap.
bool Write (parameterMap &s)
 Write to parameterMap.
virtual bool writeTerms (void)
 Write terms to disk.
virtual bool fillTerms (void)=0
 Fill out the list with pre-initialized, but empty, terms.
bool keepTerm (const_term_iterator it) const
 test if we should keep this term
double getValueSphr (double r, double theta, double phi) const
 get value at specific location, in spherical coordinates
double getErrorSphr (double r, double theta, double phi) const
 get uncertainty on value at specific location, in spherical coordinates
double getValueCart (double rS, double rO, double rL) const
 get value at specific location, in Cartesian coordinates
double getErrorCart (double rS, double rO, double rL) const
 get uncertainty on value at specific location, in Cartesian coordinates

Public Attributes

string storage_directory
string file_prefix
int lmax
bool skip_odd_l


Detailed Description

template<class TBas, class TObj>
class CHarmonicExpansion< TBas, TObj >

Simple interface for all objects that are expansions, either Spherical or Cartesian It is templated, so everything is here in header

Don't use it directly! Inherit from it. See the CSphericalHarmonicExpansion class below for example.

TBas Should inherit from CHarmonicBasisFunction and TObj Should inherit from CObject1d

Definition at line 114 of file harmonic_expansion.h.


Member Typedef Documentation

template<class TBas, class TObj>
typedef CHarmonicExpansion< TBas, TObj >::const_iterator CHarmonicExpansion< TBas, TObj >::const_term_iterator

template<class TBas, class TObj>
typedef CHarmonicExpansion< TBas, TObj >::iterator CHarmonicExpansion< TBas, TObj >::term_iterator


Constructor & Destructor Documentation

template<class TBas, class TObj>
CHarmonicExpansion< TBas, TObj >::CHarmonicExpansion ( void   )  [inline]

Definition at line 126 of file harmonic_expansion.h.

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

Definition at line 127 of file harmonic_expansion.h.

template<class TBas, class TObj>
virtual CHarmonicExpansion< TBas, TObj >::~CHarmonicExpansion ( void   )  [inline, virtual]

Definition at line 129 of file harmonic_expansion.h.


Member Function Documentation

template<class TBas, class TObj>
virtual bool CHarmonicExpansion< TBas, TObj >::fillTerms ( void   )  [pure virtual]

template<class TBas, class TObj>
double CHarmonicExpansion< TBas, TObj >::getErrorCart ( double  rS,
double  rO,
double  rL 
) const [inline, virtual]

get uncertainty on value at specific location, in Cartesian coordinates

Implements CObject3d.

Definition at line 219 of file harmonic_expansion.h.

template<class TBas, class TObj>
double CHarmonicExpansion< TBas, TObj >::getErrorSphr ( double  r,
double  theta,
double  phi 
) const [inline, virtual]

get uncertainty on value at specific location, in spherical coordinates

Implements CObject3d.

Definition at line 196 of file harmonic_expansion.h.

template<class TBas, class TObj>
double CHarmonicExpansion< TBas, TObj >::getValueCart ( double  rS,
double  rO,
double  rL 
) const [inline, virtual]

get value at specific location, in Cartesian coordinates

Implements CObject3d.

Definition at line 208 of file harmonic_expansion.h.

template<class TBas, class TObj>
double CHarmonicExpansion< TBas, TObj >::getValueSphr ( double  r,
double  theta,
double  phi 
) const [inline, virtual]

get value at specific location, in spherical coordinates

Implements CObject3d.

Definition at line 185 of file harmonic_expansion.h.

template<class TBas, class TObj>
bool CHarmonicExpansion< TBas, TObj >::keepTerm ( const_term_iterator  it  )  const [inline]

test if we should keep this term

Definition at line 180 of file harmonic_expansion.h.

template<class TBas, class TObj>
bool CHarmonicExpansion< TBas, TObj >::Read ( const parameterMap s  )  [inline, virtual]

template<class TBas, class TObj>
bool CHarmonicExpansion< TBas, TObj >::Write ( parameterMap s  )  [inline, virtual]

template<class TBas, class TObj>
virtual bool CHarmonicExpansion< TBas, TObj >::writeTerms ( void   )  [inline, virtual]

Write terms to disk.

Reimplemented from CObject3d.

Definition at line 159 of file harmonic_expansion.h.


Member Data Documentation

template<class TBas, class TObj>
string CHarmonicExpansion< TBas, TObj >::file_prefix

Definition at line 119 of file harmonic_expansion.h.

template<class TBas, class TObj>
int CHarmonicExpansion< TBas, TObj >::lmax

Definition at line 120 of file harmonic_expansion.h.

template<class TBas, class TObj>
bool CHarmonicExpansion< TBas, TObj >::skip_odd_l

Definition at line 121 of file harmonic_expansion.h.

template<class TBas, class TObj>
string CHarmonicExpansion< TBas, TObj >::storage_directory

Definition at line 118 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