DOC: API documentation fixes
[freefoam.git] / src / randomProcesses / fft / kShellIntegration.H
blobbbc03a0db8bbc9a196eb7cccf095c6287f638b48
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 1991-2010 OpenCFD Ltd.
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
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.
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.
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/>.
24 Global
25     kShellIntegration
27 Description
28     Integrate a multi-dimensional complexVectorField in k-shells
29     to create the 1D
31 SourceFiles
32     kShellIntegration.C
34 \*---------------------------------------------------------------------------*/
36 #ifndef kShellIntegration_H
37 #define kShellIntegration_H
39 #include <OpenFOAM/complexFields.H>
40 #include <randomProcesses/Kmesh.H>
41 #include <OpenFOAM/graph.H>
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 namespace Foam
48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
50 //- Integrate a mult-dimensional complexVectorField in k-shells
51 graph kShellIntegration
53     const complexVectorField& Ek,
54     const Kmesh& K
58 graph kShellMean
60     const complexVectorField& Ek,
61     const Kmesh& K
65 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
67 } // End namespace Foam
69 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
71 #endif
73 // ************************ vim: set sw=4 sts=4 et: ************************ //