BUG: UListIO: byteSize overflowing on really big faceLists
[OpenFOAM-2.0.x.git] / src / randomProcesses / Kmesh / Kmesh.H
blobde7e6d903ad44035401fbc14e1ad6eb443384456
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
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 Class
25     Foam::Kmesh
27 Description
28     Calculate the wavenumber vector field corresponding to the
29     space vector field of a finite volume mesh;
31 SourceFiles
32     Kmesh.C
34 \*---------------------------------------------------------------------------*/
36 #ifndef Kmesh_H
37 #define Kmesh_H
39 #include "fvMesh.H"
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 namespace Foam
46 /*---------------------------------------------------------------------------*\
47                            Class Kmesh Declaration
48 \*---------------------------------------------------------------------------*/
50 class Kmesh
52     public vectorField
55     // Private data
57         //- Dimensions of box
58         vector L;
60         //- Multi-dimensional addressing array
61         labelList NN;
63         //- Maximum wavenumber
64         scalar Kmax;
66 public:
68     // Constructors
70         //- Construct from fvMesh
71         Kmesh(const fvMesh&);
74     // Member Functions
76         // Access
78         const vector& sizeOfBox() const
79         {
80             return L;
81         }
83         const labelList& nn() const
84         {
85             return NN;
86         }
88         scalar max() const
89         {
90             return Kmax;
91         }
95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 } // End namespace Foam
99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101 #endif
103 // ************************************************************************* //