MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Multipole.h
Go to the documentation of this file.
1 //Copyright (c) 2013-2020, The MercuryDPM Developers Team. All rights reserved.
2 //For the list of developers, see <http://www.MercuryDPM.org/Team>.
3 //
4 //Redistribution and use in source and binary forms, with or without
5 //modification, are permitted provided that the following conditions are met:
6 // * Redistributions of source code must retain the above copyright
7 // notice, this list of conditions and the following disclaimer.
8 // * Redistributions in binary form must reproduce the above copyright
9 // notice, this list of conditions and the following disclaimer in the
10 // documentation and/or other materials provided with the distribution.
11 // * Neither the name MercuryDPM nor the
12 // names of its contributors may be used to endorse or promote products
13 // derived from this software without specific prior written permission.
14 //
15 //THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
16 //ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17 //WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 //DISCLAIMED. IN NO EVENT SHALL THE MERCURYDPM DEVELOPERS TEAM BE LIABLE FOR ANY
19 //DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20 //(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21 //LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
22 //ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 //(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
24 //SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 #ifndef MULTIPOLE_H_
26 #define MULTIPOLE_H_
27 
28 #include "Math/NumericalVector.h"
29 #include "Math/Vector.h"
30 #include <complex>
31 #include <vector>
32 
33 class Multipole
34 {
35 public:
36  Multipole(int p, NumericalVector<>* squaredFactorials, Vec3D location);
37 
38  virtual ~Multipole();
39 
40  //Multipole manipulations
41  virtual void computeMultipoleExpansion();
42 
44 
46 
47  //add a multipole to this existing multipole
48  void addMultipoleCoefficients(NumericalVector<std::complex<Mdouble>> multipoleExpansionCoefficients);
49 
51  {
53  }
54 
55  void setExpansionCoefficients(NumericalVector<std::complex<Mdouble>> multipoleExpansionCoefficients)
56  {
57  multipoleExpansionCoefficients_ = multipoleExpansionCoefficients;
58  }
59 
61  {
62  return squaredFactorials_;
63  }
64 
65  int getP()
66  {
67  return p_;
68  }
69 
70 protected:
71  int p_; // order of truncation
72  NumericalVector<>* squaredFactorials_; // required for multipole manipulations
73  Vec3D location_; // location of the multipole
75 };
76 
77 #endif /* MULTIPOLE_H_ */
virtual void computeMultipoleExpansion()
Definition: Multipole.cc:43
NumericalVector * squaredFactorials_
Definition: Multipole.h:72
Vec3D location_
Definition: Multipole.h:73
void addMultipoleCoefficients(NumericalVector< std::complex< Mdouble >> multipoleExpansionCoefficients)
Adds multipole coefficients to an existing multipole todo: remove this function; it should not be req...
Definition: Multipole.cc:153
NumericalVector< std::complex< Mdouble > > convertMultipoleToLocal(Vec3D location)
Definition: Multipole.cc:108
int p_
Definition: Multipole.h:71
NumericalVector< std::complex< Mdouble > > TranslateMultipoleExpansionTo(Vec3D location)
Definition: Multipole.cc:49
virtual ~Multipole()
NumericalVector * getSquaredFactorials()
Definition: Multipole.h:60
NumericalVector< std::complex< Mdouble > > multipoleExpansionCoefficients_
Definition: Multipole.h:74
NumericalVector< std::complex< Mdouble > > getExpansionCoefficients()
Definition: Multipole.h:50
void setExpansionCoefficients(NumericalVector< std::complex< Mdouble >> multipoleExpansionCoefficients)
Definition: Multipole.h:55
int getP()
Definition: Multipole.h:65
Multipole(int p, NumericalVector<> *squaredFactorials, Vec3D location)
Definition: Multipole.cc:33
Definition: Vector.h:49