OpenFOAM logo
Open Source CFD Toolkit

Kmesh.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2005 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software; you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by the
00013     Free Software Foundation; either version 2 of the License, or (at your
00014     option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM; if not, write to the Free Software Foundation,
00023     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00024 
00025 Class
00026     Kmesh
00027 
00028 Description
00029     Calculate the wavenumber vector field corresponding to the
00030     space vector field of a finite volume mesh;
00031 
00032 SourceFiles
00033     Kmesh.C
00034 
00035 \*---------------------------------------------------------------------------*/
00036 
00037 #ifndef Kmesh_H
00038 #define Kmesh_H
00039 
00040 #include "fvMesh.H"
00041 
00042 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00043 
00044 namespace Foam
00045 {
00046 
00047 /*---------------------------------------------------------------------------*\
00048                            Class Kmesh Declaration
00049 \*---------------------------------------------------------------------------*/
00050 
00051 class Kmesh
00052 :
00053     public vectorField
00054 {
00055 
00056     // Private data
00057 
00058         //- Dimensions of box
00059         vector L;
00060 
00061         //- Multi-dimensional addressing array
00062         labelList NN;
00063 
00064         //- Maximum wavenumber
00065         scalar Kmax;
00066 
00067 public:
00068 
00069     // Constructors
00070 
00071         //- Construct from fvMesh
00072         Kmesh(const fvMesh&);
00073 
00074 
00075     // Member Functions
00076 
00077         // Access
00078 
00079         const vector& sizeOfBox() const
00080         {
00081             return L;
00082         }
00083 
00084         const labelList& nn() const
00085         {
00086             return NN;
00087         }
00088 
00089         scalar max() const
00090         {
00091             return Kmax;
00092         }
00093 };
00094 
00095 
00096 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00097 
00098 } // End namespace Foam
00099 
00100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00101 
00102 #endif
00103 
00104 // ************************************************************************* //
For further information go to www.openfoam.org