Merge branch 'master' of ssh://git.code.sf.net/p/foam-extend/foam-extend-3.2
[foam-extend-3.2.git] / src / randomProcesses / noise / noiseFFT.H
bloba7569568737492748662326d46dd34c513ae98bc
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.
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.
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.
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/>.
24 Class
25     Foam::noiseFFT
27 Description
28     FFT of the pressure field
30 SourceFiles
31     noiseFFT.C
33 \*---------------------------------------------------------------------------*/
35 #ifndef noiseFFT_H
36 #define noiseFFT_H
38 #include "scalarField.H"
39 #include "graph.H"
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 namespace Foam
46 /*---------------------------------------------------------------------------*\
47                            Class noiseFFT Declaration
48 \*---------------------------------------------------------------------------*/
50 class noiseFFT
52     public scalarField
54     // Private data
56         //- Time spacing of the raw data
57         scalar deltat_;
60 public:
62     //- Reference pressure
63     static scalar p0;
66     // Constructors
68         //- Construct from pressure field
69         noiseFFT
70         (
71             const scalar deltat,
72             const scalarField& pressure
73         );
75         //- Construct from Istream
76         noiseFFT(Istream&);
78         //- Construct from pressure field file name
79         noiseFFT(const fileName& pFileName, const label skip = 0);
82     // Member Functions
84         //- Return the graph of p(t)
85         graph pt() const;
87         //- Return the nth window
88         tmp<scalarField> window(const label N, const label n) const;
90         //- Return the Hanning window function
91         tmp<scalarField> Hanning(const label N) const;
93         //- Return the fft of the given pressure data
94         tmp<scalarField> Pf(const tmp<scalarField>& pn) const;
96         //- Return the multi-window mean fft of the complete pressure data
97         graph meanPf(const label N, const label nw) const;
99         //- Return the multi-window RMS mean fft of the complete pressure data
100         graph RMSmeanPf(const label N, const label nw) const;
102         //- Return the narrow-band PFL (pressure-fluctuation level) spectrum
103         graph Lf(const graph& gPf) const;
105         //- Return the one-third-octave-band PFL spectrum
106         //  starting at octave with mean frequency f1
107         graph Ldelta(const graph& gLf, const scalar f1, const scalar fU) const;
109         //- Return the one-third-octave-band pressure spectrum
110         //  starting at octave with mean frequency f1
111         graph Pdelta(const graph& gLf, const scalar f1, const scalar fU) const;
113         //- Return the total PFL as the sum of Lf over all frequencies
114         scalar Lsum(const graph& gLf) const;
116         //- Convert the db into Pa
117         scalar dbToPa(const scalar db) const;
119         //- Convert the db-field into Pa
120         tmp<scalarField> dbToPa(const tmp<scalarField>& db) const;
124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
126 } // End namespace Foam
128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
130 #endif
132 // ************************************************************************* //