include/ewalena/numerics/spherical_harmonic_function.h

Go to the documentation of this file.

// -------------------------------------------------------------------
// @author Toby D. Young
// @version $Id: spherical_harmonic_function.h 702 2012-02-13 02:08:58Z oneliefleft $
//
// Copyright 2012 namespace ewalena authors. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
//
// 1. Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above
//    copyright notice, this list of conditions and the following
//    disclaimer in the documentation and/or other materials provided
//    with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE NAMEPSACE EWALENA AUTHORS ``AS
// IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
// FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
// NAMESPACE EWALENA AUTHORS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
// HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
// STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
// OF THE POSSIBILITY OF SUCH DAMAGE.
//
// The views and conclusions contained in the software and
// documentation are those of the authors and should not be
// interpreted as representing official policies, either expressed or
// implied, of the namespace ewalena authors.
// -------------------------------------------------------------------


#ifndef __ewalena_spherical_harmonic_function_h
#define __ewalena_spherical_harmonic_function_h

#ifdef EWALENA_HAVE_CONFIG_H
#include <ewalena/base/config.h>
#endif

#include <ewalena/base/orbital_type.h>
#include <ewalena/base/point.h>
#include <ewalena/base/utilities.h>


namespace ewalena
{
  
  template <int dim, typename ValueType = double>
    class SphericalHarmonicFunction
    {
    public:
    
    SphericalHarmonicFunction () 
    {};
    
    ~SphericalHarmonicFunction ();
    
    ValueType value (const OrbitalType     &orbital,
                     Point<dim, ValueType> &p);
    
    private:
    
    ValueType l1_value (const int              m,
                        Point<dim, ValueType> &p);
    
    ValueType l2_value (const int              m,
                        Point<dim, ValueType> &p);
    
    }; /* SphericalHarmonicFunction */

  
  /*-------------- Inline and Other Functions -----------------------*/
  
}

#endif /* __ewalena_spherical_harmonic_function_h */