FreeFOAM The Cross-Platform CFD Toolkit
Kmesh.H
Go to the documentation of this file.
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.
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
13  the Free Software Foundation, either version 3 of the License, or
14  (at your 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, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::Kmesh
26 
27 Description
28  Calculate the wavenumber vector field corresponding to the
29  space vector field of a finite volume mesh;
30 
31 SourceFiles
32  Kmesh.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef Kmesh_H
37 #define Kmesh_H
38 
39 #include <finiteVolume/fvMesh.H>
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class Kmesh Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 class Kmesh
51 :
52  public vectorField
53 {
54 
55  // Private data
56 
57  //- Dimensions of box
58  vector L;
59 
60  //- Multi-dimensional addressing array
61  labelList NN;
62 
63  //- Maximum wavenumber
64  scalar Kmax;
65 
66 public:
67 
68  // Constructors
69 
70  //- Construct from fvMesh
71  Kmesh(const fvMesh&);
72 
73 
74  // Member Functions
75 
76  // Access
77 
78  const vector& sizeOfBox() const
79  {
80  return L;
81  }
82 
83  const labelList& nn() const
84  {
85  return NN;
86  }
87 
88  scalar max() const
89  {
90  return Kmax;
91  }
92 };
93 
94 
95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96 
97 } // End namespace Foam
98 
99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
100 
101 #endif
102 
103 // ************************ vim: set sw=4 sts=4 et: ************************ //