src/randomProcesses/fft/fft.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation, either version 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  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
  57     enum transformDirection
  58     {
  59         FORWARD_TRANSFORM = 1,
  60         REVERSE_TRANSFORM = -1
  61     };
  62
  63
  64     static void transform
  65     (
  66         complexField& field,
  67         const labelList& nn,
  68         transformDirection fftDirection
  69     );
  70
  71
  72     static tmp<complexField> forwardTransform
  73     (
  74         const tmp<complexField>& field,
  75         const labelList& nn
  76     );
  77
  78
  79     static tmp<complexField> reverseTransform
  80     (
  81         const tmp<complexField>& field,
  82         const labelList& nn
  83     );
  84
  85
  86     static tmp<complexVectorField> forwardTransform
  87     (
  88         const tmp<complexVectorField>& field,
  89         const labelList& nn
  90     );
  91
  92
  93     static tmp<complexVectorField> reverseTransform
  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 // ************************************************************************* //