fft.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::fft
26 
27 Description
28  Fast fourier transform derived from the Numerical
29  Recipes in C routine.
30 
31  The complex transform field is returned in the field supplied. The
32  direction of transform is supplied as an argument (1 = forward, -1 =
33  reverse). The dimensionality and organisation of the array of values
34  in space is supplied in the nn indexing array.
35 
36 SourceFiles
37  fft.C
38 
39 \*---------------------------------------------------------------------------*/
40 
41 #ifndef fft_H
42 #define fft_H
43 
44 #include "complexFields.H"
45 #include "labelList.H"
46 
47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
48 
49 namespace Foam
50 {
51 
52 class fft
53 {
54 
55 public:
56 
58  {
61  };
62 
63 
64  static void transform
65  (
66  complexField& field,
67  const labelList& nn,
68  transformDirection fftDirection
69  );
70 
71 
73  (
74  const tmp<complexField>& field,
75  const labelList& nn
76  );
77 
78 
80  (
81  const tmp<complexField>& field,
82  const labelList& nn
83  );
84 
85 
87  (
88  const tmp<complexVectorField>& field,
89  const labelList& nn
90  );
91 
92 
94  (
95  const tmp<complexVectorField>& field,
96  const labelList& nn
97  );
98 };
99 
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 } // End namespace Foam
104 
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106 
107 #endif
108 
109 // ************************************************************************* //
Pre-declare SubField and related Field type.
Definition: Field.H:83
Fast fourier transform derived from the Numerical Recipes in C routine.
Definition: fft.H:52
static tmp< complexField > reverseTransform(const tmp< complexField > &field, const labelList &nn)
Definition: fft.C:203
static void transform(complexField &field, const labelList &nn, transformDirection fftDirection)
Definition: fft.C:42
transformDirection
Definition: fft.H:57
@ REVERSE_TRANSFORM
Definition: fft.H:59
@ FORWARD_TRANSFORM
Definition: fft.H:58
static tmp< complexField > forwardTransform(const tmp< complexField > &field, const labelList &nn)
Definition: fft.C:187
A class for managing temporary objects.
Definition: tmp.H:55
Namespace for OpenFOAM.