src/randomProcesses/fft/fft.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::fft
  27
  28 Description
  29     Fast fourier transform derived from the Numerical
  30     Recipes in C routine.
  31
  32     The complex transform field is returned in the field supplied.  The
  33     direction of transform is supplied as an argument (1 = forward, -1 =
  34     reverse).  The dimensionality and organisation of the array of values
  35     in space is supplied in the nn indexing array.
  36
  37 SourceFiles
  38     fft.C
  39
  40 \*---------------------------------------------------------------------------*/
  41
  42 #ifndef fft_H
  43 #define fft_H
  44
  45 #include "complexFields.H"
  46 #include "labelList.H"
  47
  48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  49
  50 namespace Foam
  51 {
  52
  53 class fft
  54 {
  55
  56 public:
  57
  58     enum transformDirection
  59     {
  60         FORWARD_TRANSFORM = 1,
  61         REVERSE_TRANSFORM = -1
  62     };
  63
  64
  65     static void transform
  66     (
  67         complexField& field,
  68         const labelList& nn,
  69         transformDirection fftDirection
  70     );
  71
  72
  73     static tmp<complexField> forwardTransform
  74     (
  75         const tmp<complexField>& field,
  76         const labelList& nn
  77     );
  78
  79
  80     static tmp<complexField> reverseTransform
  81     (
  82         const tmp<complexField>& field,
  83         const labelList& nn
  84     );
  85
  86
  87     static tmp<complexVectorField> forwardTransform
  88     (
  89         const tmp<complexVectorField>& field,
  90         const labelList& nn
  91     );
  92
  93
  94     static tmp<complexVectorField> reverseTransform
  95     (
  96         const tmp<complexVectorField>& field,
  97         const labelList& nn
  98     );
  99 };
 100
 101
 102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 103
 104 } // End namespace Foam
 105
 106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 107
 108 #endif
 109
 110 // ************************************************************************* //