fftRenumber.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-2024 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 Global
25  fftRenumber
26 
27 Description
28  Multi-dimensional renumbering used in the Numerical Recipes
29  fft routine.
30 
31 SourceFiles
32  fftRenumber.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef fftRenumber_H
37 #define fftRenumber_H
38 
39 #include "complex.H"
40 #include "List.H"
41 #include "labelList.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
49 
50 // Recursively evaluate the indexing necessary to do the folding of the fft
51 // data. We recurse until we have the indexing necessary for the folding in all
52 // directions.
54 (
55  List<complex>& data,
56  List<complex>& renumData,
57  const labelList& nn,
58  label nnprod,
59  label ii,
60  label l1,
61  label l2
62 );
63 
64 
65 // Fold the n-d data array to get the fft components in the right places.
66 void fftRenumber
67 (
68  List<complex>& data,
69  const labelList& nn
70 );
71 
72 
73 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
74 
75 } // End namespace Foam
76 
77 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
78 
79 #endif
80 
81 // ************************************************************************* //
Namespace for OpenFOAM.
void fftRenumber(List< complex > &data, const labelList &nn)
Definition: fftRenumber.C:96
List< label > labelList
A List of labels.
Definition: labelList.H:56
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
void fftRenumberRecurse(List< complex > &data, List< complex > &renumData, const labelList &nn, label nnprod, label ii, label l1, label l2)
Definition: fftRenumber.C:36