FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

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-2010 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
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your 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, see <http://www.gnu.org/licenses/>.
00023 
00024 Class
00025     Foam::Kmesh
00026 
00027 Description
00028     Calculate the wavenumber vector field corresponding to the
00029     space vector field of a finite volume mesh;
00030 
00031 SourceFiles
00032     Kmesh.C
00033 
00034 \*---------------------------------------------------------------------------*/
00035 
00036 #ifndef Kmesh_H
00037 #define Kmesh_H
00038 
00039 #include <finiteVolume/fvMesh.H>
00040 
00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00042 
00043 namespace Foam
00044 {
00045 
00046 /*---------------------------------------------------------------------------*\
00047                            Class Kmesh Declaration
00048 \*---------------------------------------------------------------------------*/
00049 
00050 class Kmesh
00051 :
00052     public vectorField
00053 {
00054 
00055     // Private data
00056 
00057         //- Dimensions of box
00058         vector L;
00059 
00060         //- Multi-dimensional addressing array
00061         labelList NN;
00062 
00063         //- Maximum wavenumber
00064         scalar Kmax;
00065 
00066 public:
00067 
00068     // Constructors
00069 
00070         //- Construct from fvMesh
00071         Kmesh(const fvMesh&);
00072 
00073 
00074     // Member Functions
00075 
00076         // Access
00077 
00078         const vector& sizeOfBox() const
00079         {
00080             return L;
00081         }
00082 
00083         const labelList& nn() const
00084         {
00085             return NN;
00086         }
00087 
00088         scalar max() const
00089         {
00090             return Kmax;
00091         }
00092 };
00093 
00094 
00095 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00096 
00097 } // End namespace Foam
00098 
00099 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00100 
00101 #endif
00102 
00103 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines