Nektar++
NektarFFT.cpp
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File NektarFFT.cpp
4 //
5 // For more information, please see: http://www.nektar.info
6 //
7 // The MIT License
8 //
9 // Copyright (c) 2006 Division of Applied Mathematics, Brown University (USA),
10 // Department of Aeronautics, Imperial College London (UK), and Scientific
11 // Computing and Imaging Institute, University of Utah (USA).
12 //
13 // License for the specific language governing rights and limitations under
14 // Permission is hereby granted, free of charge, to any person obtaining a
15 // copy of this software and associated documentation files (the "Software"),
16 // to deal in the Software without restriction, including without limitation
17 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
18 // and/or sell copies of the Software, and to permit persons to whom the
19 // Software is furnished to do so, subject to the following conditions:
20 //
21 // The above copyright notice and this permission notice shall be included
22 // in all copies or substantial portions of the Software.
23 //
24 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
25 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
27 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
29 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
30 // DEALINGS IN THE SOFTWARE.
31 //
32 // Description: Fast Fourier Transform base class in Nektar++
33 //
34 ///////////////////////////////////////////////////////////////////////////////
35 
37 #include <loki/Singleton.h> // for CreateUsingNew, NoDestroy, etc
38 
39 namespace Nektar
40 {
41  namespace LibUtilities
42  {
43  /**
44  * @class NektarFFT
45  *
46  * This class is a base class for all FFT implementation. It provides
47  * the underlying generic functionality and interface for perform a Fourier transform.
48  *
49  * To perform the FFT with a differebt algorithm, create a derived class from this class
50  * and reimplement the virtual functions to provide custom implementation
51  * of the algorithm.
52  *
53  */
54 
55  /**
56  * This constructor is protected as the objects of this class are never
57  * instantiated directly.
58  */
60  {
61  m_N = N;
62  }
63 
65  {
66 
67  }
68 
70  {
71  typedef Loki::SingletonHolder<NektarFFTFactory,
72  Loki::CreateUsingNew,
73  Loki::NoDestroy,
74  Loki::ClassLevelLockable> Type;
75  return Type::Instance();
76  }
77 
78  /**
79  * This allows initialisation of the class which cannot be completed
80  * during object construction (such as setting of initial conditions).
81  *
82  * Public interface routine to virtual function implementation.
83  */
84 
86  {
87  v_FFTFwdTrans(phys,coef);
88  }
89 
91  {
92  v_FFTBwdTrans(coef,phys);
93  }
94 
96  {
97 
98  }
99 
101  {
102 
103  }
104 
105  }//end namespace LibUtilities
106 }//end of namespace Nektar
void FFTBwdTrans(Array< OneD, NekDouble > &coef, Array< OneD, NekDouble > &phys)
Definition: NektarFFT.cpp:90
NektarFFT(int N)
Initialises NektarFFT class members.
Definition: NektarFFT.cpp:59
virtual void v_FFTFwdTrans(Array< OneD, NekDouble > &phys, Array< OneD, NekDouble > &coef)
Definition: NektarFFT.cpp:95
NektarFFTFactory & GetNektarFFTFactory()
Definition: NektarFFT.cpp:69
void FFTFwdTrans(Array< OneD, NekDouble > &phy, Array< OneD, NekDouble > &coef)
Definition: NektarFFT.cpp:85
LibUtilities::NekFactory< std::string, NektarFFT, int > NektarFFTFactory
Datatype of the NekFactory used to instantiate classes derived from the NektarFFT class...
Definition: NektarFFT.h:63
virtual void v_FFTBwdTrans(Array< OneD, NekDouble > &coef, Array< OneD, NekDouble > &phys)
Definition: NektarFFT.cpp:100
Provides a generic Factory class.
Definition: NekFactory.hpp:116